mirror of
https://github.com/AkiChase/scrcpy-mask
synced 2025-04-21 04:25:13 +08:00
doc: update README
This commit is contained in:
parent
907f0f28ca
commit
4c92199476
12
README-zh.md
12
README-zh.md
@ -91,14 +91,16 @@
|
||||
|
||||
## 错误报告
|
||||
|
||||
提问时请尽可能全面而清晰地提供问题相关的信息,包括操作系统和软件版本。特别是如果有错误输出,请务必附带相关日志。
|
||||
提交错误报告时请尽可能全面而清晰地提供问题相关的信息,包括操作系统和软件版本,相关错误日志。
|
||||
|
||||
日志有两个来源,可能对定位并解决错误有所帮助。一般来说,Web 日志中就可以找到错误输出。
|
||||
日志有两个来源,可能对定位并解决错误有所帮助。
|
||||
|
||||
1. Web 日志:通过 `Ctrl+Shift+I` 或 `Cmd+Opt+I` 打开开发者工具,点击控制台 (console),查看控制台内输出的信息。
|
||||
2. Rust 日志:
|
||||
1. 在 macOS 或 Linux 系统下,可以进入安装位置,使用**终端**运行 `scrcpy-mask`,可在终端中实时看到程序的输出信息。
|
||||
2. 在 Windows 系统下,目前只能克隆项目后自行运行,查看 Rust 输出信息。
|
||||
2. 持久化日志:
|
||||
- 不同系统日志路径不同,可在 设置页面 -> 数据管理 -> 日志目录 中快速查看
|
||||
- Linux: /home/<用户名>/.local/share/com.akichase.mask/logs
|
||||
- macOS: /Users/<用户名>/Library/Logs/com.akichase.mask
|
||||
- Windows: C:\Users\<用户名>\AppData\Local\com.akichase.mask\logs
|
||||
|
||||
## 贡献
|
||||
|
||||
|
14
README.md
14
README.md
@ -93,14 +93,16 @@ For instance, the `key-input-mode` macro can switch from key mapping mode to key
|
||||
|
||||
## 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.
|
||||
When submitting a bug report, please provide as much comprehensive and clear information as possible regarding the issue, including operating system and software versions, and relevant error 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.
|
||||
There are two sources of logs that may be helpful in locating and resolving the issue.
|
||||
|
||||
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.
|
||||
1. Web Logs: Open the developer tools using `Ctrl+Shift+I` or `Cmd+Opt+I`, then go to the Console tab to check the output in the console.
|
||||
2. Persistent Logs:
|
||||
- The log directory may vary depending on the system. You can quickly find it in the "Settings page -> Data management -> Log dir".
|
||||
- Linux: /home/<username>/.local/share/com.akichase.mask/logs
|
||||
- macOS: /Users/<username>/Library/Logs/com.akichase.mask
|
||||
- Windows: C:\Users\<username>\AppData\Local\com.akichase.mask\logs
|
||||
|
||||
## Contribution.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user