1
0
mirror of https://github.com/LearnOpenGL-CN/LearnOpenGL-CN.git synced 2025-08-23 04:35:28 +08:00

Update readme

This commit is contained in:
Meow J
2016-07-04 19:42:26 +08:00
parent ac329fa614
commit d833a722e8
2 changed files with 28 additions and 1 deletions

4
.gitignore vendored
View File

@@ -1,2 +1,4 @@
*/._.*
*.DS_Store
*.DS_Store
/site
/build

View File

@@ -12,6 +12,8 @@ learnopengl.com系列教程的中文翻译目前正在翻译中。
目前Host在Read The Docs上可以[点击这里](http://learnopengl-cn.readthedocs.io/)进行阅读。
还有一份在GitHub上采用新的主题可以[点击这里](https://learnopengl-cn.github.io/)阅读。
## 认领翻译
由于我们的志愿者来自五湖四海为了避免冲突。请志愿者们先Clone这个Repository 。同步到本地后找到要翻译的文章创建一个如下所示的只包含作者、翻译者和原文链接信息的Markdown文件
@@ -46,6 +48,29 @@ learnopengl.com系列教程的中文翻译目前正在翻译中。
之后请联系我们将您加入LearnOpenGL-CN组织然后提交并Push您的翻译。或者您也可以Fork这个工程在本地编辑之后发送Pull Request。
## 构建
首先请安装Python2和3都可以之后初始化环境
```bash
$ pip install mkdocs
$ python setup.py install
```
初始化以后,每次构建只需要输入以下指令即可,构建后的文件在`site`文件夹内:
```bash
$ mkdocs build
```
如果只是想测试的话,请输入以下指令:
```bash
$ mkdocs serve
```
部署的网页可以通过`127.0.0.1:8000`来访问。
## 建议
如果您发现文档有任何错误的话欢迎Fork这个工程并发送Pull Request到 `master` 分支。如果您不想修改的话,可以点击页面上方的 `Issues` 按钮提交一个Issue我们看到后会及时更正。