doc(README): bug report

This commit is contained in:
AkiChase 2024-05-23 13:26:57 +08:00
parent ce3804e120
commit f19941f8bd
2 changed files with 22 additions and 0 deletions

View File

@ -84,6 +84,17 @@
[{ "args": [], "type": "key-input-mode" }]
```
## 错误报告
提问时请尽可能全面而清晰地提供问题相关的信息,包括操作系统和软件版本。特别是如果有错误输出,请务必附带相关日志。
日志有两个来源可能对定位并解决错误有所帮助。一般来说Web 日志中就可以找到错误输出。
1. Web 日志:通过 `Ctrl+Shift+I``Cmd+Opt+I` 打开开发者工具,点击控制台 (console),查看控制台内输出的信息。
2. Rust 日志:
1. 在 macOS 或 Linux 系统下,可以进入安装位置,使用**终端**运行 `scrcpy-mask`,可在终端中实时看到程序的输出信息。
2. 在 Windows 系统下,目前只能克隆项目后自行运行,查看 Rust 输出信息。
## 贡献
如果你对这个项目感兴趣,欢迎提 PR 或 Issue。但我的时间和精力有限所以可能无法全部及时处理。

View File

@ -86,6 +86,17 @@ For instance, the `key-input-mode` macro can switch from key mapping mode to key
[{ "args": [], "type": "key-input-mode" }]
```
## Error Report
When asking a question, please provide as much detailed information as possible regarding the issue, including the operating system and software version. Specifically, if there is an error output, please be sure to include the relevant logs.
There are two sources of logs that might help in identifying and solving the error. Generally, the error output can be found in the Web logs.
1. Web Logs: Open Developer Tools by pressing `Ctrl+Shift+I` or `Cmd+Opt+I`, click on the console tab, and check the information output in the console.
2. Rust Logs:
1. On macOS or Linux, navigate to the installation directory, use the **terminal** to run `scrcpy-mask`, and you can see the program's output in real-time in the terminal.
2. On Windows, you need to clone the project and run it yourself to view the Rust output.
## Contribution.
If you are interested in this project, you are welcome to submit pull request or issue. But my time and energy is limited, so I may not be able to deal with it all.