Skip to content
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.

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

optimize readme and doc again, and translate the doc to English #118

Open
wants to merge 13 commits into
base: master
Choose a base branch
from

Conversation

R3c0ger
Copy link
Contributor

@R3c0ger R3c0ger commented Nov 22, 2024

  • Use Chinese punctuation for Chinese text and English punctuation for English text.
  • Add spaces around the comment symbols in markdown code blocks.
  • Adjust indent and alignment of some code and comments in code blocks.
  • Included the missing modifications from the previous PR.

  • 修改标点,中文用中文标点,英文用英文标点;
  • 修改代码块中的注释,注释符号两边加空格;
  • 修改代码块中的缩进与对齐;
  • 补上上次PR的提交中漏掉的应当修改的地方。

文档的文件名改了,名字里面带空格总感觉有些刺挠,另一方面也算是给英文文档“留空”,如果作者接受的话,还得麻烦您改一下项目网站里的“手册与教程”的链接了(另外建议您在 README 界面的 About 里面附上官网网址,只放在 README 里面的话,我一开始还误以为只是个下载用的链接呢)。

没看住 VSCode,提交时没保存我最新的 commit message,本来一次提交就完事了的(半恼)

提交完这个就接着整翻译了!

- Use Chinese punctuation for Chinese text and English punctuation for English text.
- Comments in code blocks: Add spaces around the comment symbols.
- Indentation and alignment in code blocks: Adjusted for consistency.
- Included the missing modifications from the previous PR.
- Use Chinese punctuation for Chinese text and English punctuation for
  English text.
- Add spaces around the comment symbols in markdown code blocks.
- Adjust indent and alignment of some code and comments in code blocks.
- Included the missing modifications from the previous PR.
- Add spaces between:
  - `if` and the left parenthesis,
  - before `return` in `if-return` statements,
  - around some operators,
  - around comments,
  - and between parameters.
- Standardize punctuation in comments to use Chinese punctuation.
- Replace `\t` tab indents with four spaces.

In the document part outside the code blocks, make the following changes
which were overlooked in the previous PR:
- Add a space after `C++`.
- Change unordered list syntax from `*` to `-`.

---

- 在 if 和左括号之间、if-return 的 return 前面、部分运算符两边、
  注释的中英文之间、参数之间添加空格;
- 将注释中的标点统一为中文标点;
- 将 `\t` 缩进换为四个空格缩进。

在代码块以外的文档部分中,作出如下修改,这是之前的 PR 中所遗漏的:
- `C++` 右边添加空格;
- 将无序列表的语法 `*` 改成 `-`。
The link of the badge would lead us to the fork of
the repository, not the original repository.

Also add some paragraph that omitted in the last
commit.
@R3c0ger R3c0ger changed the title optimize readme and doc again optimize readme and doc again, and translate the doc to English Nov 23, 2024
@R3c0ger
Copy link
Contributor Author

R3c0ger commented Nov 23, 2024

使用通义千问为主、Copilot 与手动修改为辅方式翻译,prompt 如下:

请你翻译上述Markdown文档中的所有中文内容,包括代码块中的中文注释。请注意,你的翻译结果必须保留原来的Markdown格式,任何链接和代码块中的缩进也不要动(尤其是不要吞掉插入图片语法的感叹号),同时也必须将翻译好的内容包裹在代码块中再发送过来。除了包裹在代码块中的、翻译过后的内容之外,不要说其他任何东西。请你在翻译的同时调整标点符号,不要出现两句英文中间有逗号的情况。

@R3c0ger
Copy link
Contributor Author

R3c0ger commented Nov 23, 2024

@matrixcascade 另外,请问您的那个狐狸是 fox 还是 gopher?()

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant