docs: make README.md the primary English doc; add Chinese README.zh-CN.md with full API coverage#1
Draft
Copilot wants to merge 1 commit into
Draft
Conversation
…E.zh-CN.md Agent-Logs-Url: https://github.com/XFEstudio/XFEExtension.NetCore.InputSimulator/sessions/5a53f642-8379-4699-bbb1-de8be9bf1633 Co-authored-by: XFEstudio <132526994+XFEstudio@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
XFEstudio
May 7, 2026 09:04
View session
There was a problem hiding this comment.
Pull request overview
This PR modernizes the project documentation by making README.md the primary English README and adding a full-featured Simplified Chinese counterpart (README.zh-CN.md), aiming to bring the docs in sync with the current public API surface.
Changes:
- Rewrites
README.mdin English with badges, language switcher, updated usage examples, and an API reference table. - Adds
README.zh-CN.mdwith equivalent coverage in Simplified Chinese, including clipboard and DPI-scaling APIs.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 12 comments.
| File | Description |
|---|---|
| README.md | Rewritten as the primary English README with badges, examples, and API reference. |
| README.zh-CN.md | New Simplified Chinese README mirroring the English README’s coverage and structure. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| [](https://dotnet.microsoft.com/download/dotnet/8.0) | ||
|
|
||
| InputSimulator是一个简单的模拟键盘输入的包，其中包含了模拟键盘按键输入和鼠标输入 | ||
| **English** | [简体中文](README.zh-CN.md) |
Comment on lines
+85
to
+87
| Point screenSize = InputSimulator.GetScreenSize(); // Screen resolution (width x height) | ||
| Point mousePos = InputSimulator.GetMousePosition(); // Current mouse cursor position | ||
| (double X, double Y) rel = InputSimulator.GetMousePointRelatively(); // Mouse position as a ratio of screen size (0.0–1.0) |
| Point screenSize = InputSimulator.GetScreenSize(); // Screen resolution (width x height) | ||
| Point mousePos = InputSimulator.GetMousePosition(); // Current mouse cursor position | ||
| (double X, double Y) rel = InputSimulator.GetMousePointRelatively(); // Mouse position as a ratio of screen size (0.0–1.0) | ||
| bool isDown = InputSimulator.GetMouseDown(MouseButton.Left); // Check whether the left mouse button is held down |
Comment on lines
+136
to
+137
| | `SetClipboardContent(string text, uint format)` | Write text to the clipboard | | ||
| | `GetClipboardContent(uint format)` | Read content from the clipboard | |
| [](LICENSE) | ||
| [](https://dotnet.microsoft.com/download/dotnet/8.0) | ||
|
|
||
| [English](README.md) | **简体中文** |
Comment on lines
+136
to
+137
| | `SetClipboardContent(string text, uint format)` | 将文本写入剪切板 | | ||
| | `GetClipboardContent(uint format)` | 从剪切板读取内容 | |
Comment on lines
+56
to
+58
| InputSimulator.LocateTo(1900, 202); | ||
| InputSimulator.LocateTo(new Point(0, 0)); | ||
|
|
| | `PressKey(char key)` | Press and immediately release the specified key | | ||
| | `PressKeyAsync(char key, int holdTime)` | Hold the key for the given duration then release (async) | | ||
| | `InputKeys(string keys)` | Press each character in the string in sequence | | ||
| | `InputKeysAsync(string keys, int holdTime, int delay)` | Press each key with configurable hold time and delay (async) | |
Comment on lines
+56
to
+58
| InputSimulator.LocateTo(1900, 202); | ||
| InputSimulator.LocateTo(new Point(0, 0)); | ||
|
|
| | `PressKey(char key)` | 按下并立即松开指定按键 | | ||
| | `PressKeyAsync(char key, int holdTime)` | 按住指定按键一段时间后松开（异步） | | ||
| | `InputKeys(string keys)` | 依次按下字符串中的每个按键 | | ||
| | `InputKeysAsync(string keys, int holdTime, int delay)` | 依次按下每个按键，支持按住时长和间隔延迟（异步） | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The existing README was Chinese-only, outdated (wrong method names, missing APIs), and lacked any package metadata badges.
Changes
README.md— rewritten as primary English documentREADME.zh-CN.mdREADME.zh-CN.md— new Chinese documentREADME.mdMove()→MouseMove(), addedInputSimulator.prefix on info methods, added async overloads,GetScalingFactorForWindow, and theClipboard/ClipboardFormatsection that was entirely absent