Skip to content

Commit b2cb654

Browse files
committed
Update README.md
1 parent 30690ef commit b2cb654

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Flask Docs Translation
22

3+
这里是 Flask 文档中文翻译项目,欢迎参与!在开始翻译之前,请务必阅读下面的 Contributing Guide 了解贡献流程,然后阅读[这个 Issue](https://github.com/greyli/flask-docs-zh/issues/11) 了解翻译基本要求和建议,并在[这个 Dicussion](https://github.com/greyli/flask-docs-zh/discussions/12) 投票选出你认为合适的翻译词汇。
4+
5+
如果有其他问题和相关想法,请[创建 Discussion](https://github.com/greyli/flask-docs-zh/discussions/new) 发起讨论;如果对翻译流程和项目设置有改进建议,或是发现了翻译错误和笔误,请[创建 Issue](https://github.com/greyli/flask-docs-zh/issues/new) 反馈。
6+
7+
这个项目在后期会转移到 [Flask Community Work Group](https://github.com/flaskcwg) 组织,并链接到 Flask 官方文档作为官方中文翻译。
8+
39

410
## Contributing Guide
511

@@ -10,9 +16,9 @@
1016
- Clone your fork repository locally (replace `{username}` with your username):
1117

1218
```
13-
$ git clone https://github.com/{username}/flask-docs-<UPDATE THIS>
14-
$ cd flask-docs-<UPDATE THIS>
15-
$ git remote add upstream https://github.com/<UPDATE THIS>/flask-docs-<UPDATE THIS>
19+
$ git clone https://github.com/{username}/flask-docs-zh
20+
$ cd flask-docs-zh
21+
$ git remote add upstream https://github.com/greyli/flask-docs-zh
1622
```
1723

1824
- Create a virtual environment and install requirements:
@@ -74,7 +80,7 @@ $ git fetch upstream
7480
$ git checkout -b your-branch-name upstream/main
7581
```
7682

77-
- Translate the `.po` file in the `docs/locales/<LANG>/LC_MESSAGES` directory.
83+
- Translate the `.po` file in the `docs/locales/zh_CN/LC_MESSAGES` directory.
7884

7985
An example of one such file, from docs/.../index.po, is given below.
8086

@@ -108,7 +114,7 @@ Please be careful not to break reST notation. Most po-editors will help you with
108114
- Commit the changes:
109115

110116
```
111-
$ git add docs/locales/<LANG>/LC_MESSAGES/example.po README.md
117+
$ git add docs/locales/zh_CN/LC_MESSAGES/example.po README.md
112118
$ git commit -m "Translate docs/example"
113119
```
114120

0 commit comments

Comments
 (0)