Skip to content

docs(zh_cn): 项目路径不能有中文 #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Craun718 wants to merge 3 commits into
base: main
Choose a base branch
from
+7 −4
Open

docs(zh_cn): 项目路径不能有中文 #37

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5cb2f9b
docs(zh_cn): add note about avoiding Chinese characters in project path
NtskwK May 8, 2026
b9388f7
Update docs/zh_cn/develop/how_to_develop.md
Craun718 May 9, 2026
b3b6696
Update docs/zh_cn/develop/how_to_develop.md
Craun718 May 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions docs/zh_cn/develop/how_to_develop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@
git clone https://github.com/MaaXYZ/MaaPracticeBoilerplate.git
```

> [!NOTE]
> 请注意，项目的路径中不能有中文。

2. 下载 OCR（文字识别）资源文件 [ppocr_v5.zip](https://download.maafw.xyz/MaaCommonAssets/OCR/ppocr_v5/ppocr_v5-zh_cn.zip) 解压到 `assets/resource/model/ocr/` 目录下，确保路径如下：

```tree
Expand All @@ -34,7 +37,7 @@
└── rec.onnx
```

> [!WARNING]
> [!WARNING]
> 请注意，您不需要将 OCR 资源文件上传到您的代码仓库中。`.gitignore` 已经忽略了 `assets/resource/model/ocr/` 目录，且 GitHub workflow 在发布版本时会自动配置这些资源文件。

_如果希望使用其他版本的模型，可以参考[这个说明](https://github.com/MaaXYZ/MaaCommonAssets/tree/main/OCR)。_
Expand All @@ -56,10 +59,10 @@

5. 发布您的版本

本模板附带 GitHub Actionss 工作流的配置文件，CI 检测到 tag 会自动将 [MFAAvalonia](https://github.com/SweetSmellFox/MFAAvalonia) 与你的项目一同打包和发版。
本模板附带 GitHub Actions 工作流的配置文件，CI 检测到 tag 会自动将 [MFAAvalonia](https://github.com/SweetSmellFox/MFAAvalonia) 与你的项目一同打包和发版。

> [!NOTE]
> 第一次操作前，需要**先**修改 Github 仓库设置 `Settings` - `Actions` - `General` - `Read and write permissions` - `Save`
> [!NOTE]
> 第一次操作前，需要**先**修改 GitHub 仓库设置 `Settings` - `Actions` - `General` - `Read and write permissions` - `Save`

```bash
# CI 检测到 tag 会自动进行发版
Expand Down