Skip to content

Commit

Permalink
修改README
Browse files Browse the repository at this point in the history
  • Loading branch information
@chunhuajiang
chunhuajiang committed May 21, 2017
1 parent 4366f7b commit 4df3bff
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 177 deletions.
55 changes: 0 additions & 55 deletions CONTRIBUTING.rst
View file

This file was deleted.

40 changes: 40 additions & 0 deletions CONTRIBUTION.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# 贡献流程

> 如果在阅读完此说明后，你还有任何疑问，Don't hestitate to contact me! QQ:1107953149
> 注意，本仓库默认的分支是 `zh`，请不要将翻译提交到 `master` 分支上面了
在 github 上

- 【步骤1】点击仓库右上角的 Fork 图标将仓库 fork 到你自己的账户下

在客户端

- 【步骤2】将你 fork 的仓库 clone 到本地：`git clone git@github.com:Your_GitHub_User_Name/esp-idf-zh.git && cd esp-idf-zh`
- 【步骤3】新建一个分支(假设分支名为`new`)，并切换到该分支:`git checkout -b new`
- 【步骤4】在你的`new`分支上修改文章，然后分别执行 git add、git commit 将改动提交到本地库，并记住此次提交的 commit id(假设此次提交生成的 commit id 为 `9057042`)
- 【步骤5】切换回`zh`分支，先将你本地仓库的`zh`分支与我的仓库同步，依次执行：
- `git remote add tidyjiang8 https://github.com/tidyjiang8/esp-idf-zh.git`(这个步骤只需要执行一次，今后再修改文章时不用执行了)
- `git remote update`
- `git merge tidyjiang8`
- 【步骤6】将你在你的新分支上修改的东西合并到 zh 分支
- 执行 `git cherry-pick <commit-id>`, 即 `git cherry-pick 9057042`

> 合并`new`分支改动时，我们用`git cherry-pick`命令，而不是`git merge`命令，这样的好处是当你可以只合并某一次的修改提交
- 【步骤7】将你的本地 zh 分支 push 到你的远程仓库：`git push origin zh`

在 github 上

- 【步骤8】进入你的仓库,在仓库下面有个 pull request 链接，点击该链接，然后填写一些说明后提交 PR

在客户端
- 【步骤9】如果你又想修改新文章，先执行【步骤5】将你本地`zh`与我的仓库同步
- 【步骤10】切换到你的`new`分支，将本地`zh`分支的内容合并到`new`分支：`git merge zh`，然后跳转到【步骤4】依次执行

> 当你提交 PR 后，会触在服务器 http://iot-fans.xyz 上设置的编译规则。服务器会尝试拉取你提交的内容，尝试将其编译为 html 文件。如果编译有问题，请先修改你翻译的部分，然后依次执行 `git add xxx`、`git commit --amend`、`git push original zh -f`重新提交；如果编译没有问题，我会合并你的 PR，此时会再次触发服务器的设置，并将你提交的内容自动部署到我的服务器 http://iot-fans.xyz/ 上面。
# 说明
- 文档使用的是以 .rst 作为后缀的 reStructuredText 格式。你不需要学习它的语法，只需要在原始的英文文档中将对应的英文替换为中文就可以了，但是请不要破坏文档原有的格式标记。
- 请采用意译，不要采用直译，但是尽量保持与原文一致。
- 为了提高翻译质量，提交 PR 前请先反复阅读、修正您的翻译。
- 为了避免翻译重复，请先在翻译前修改[PROCESS.md](PROCESS.md)，然后提交 PR。请不要翻译已经被领取了的章节。
134 changes: 12 additions & 122 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,127 +1,17 @@
# ESP-IDF 中文文档
# ESP-IDF 编程指南 - 中文版

## 预览 [http://iot-fans.xyz/esp/esp-idf-zh/](http://iot-fans.xyz/esp/esp-idf-zh/)
本文档是 ESP-IDF 官方文档的中文翻译版。

## 翻译进度
## 在线阅读：
- 中文版地址：[http://iot-fans.xyz/esp/esp-idf-zh/](http://iot-fans.xyz/esp/esp-idf-zh/)
- 英文版地址：[http://esp-idf.readthedocs.io/en/latest/](http://esp-idf.readthedocs.io/en/latest/)

状态：
- 翻译中
- 完成
## 参与翻译：
- 所有的`.rst`文件和部分的`.h`文件是需要翻译的源文件。翻译前求务必阅读 [CONTRIBUTION.md](CONTRIBUTION.md)。
- 同时也欢迎修您正在阅读时发现的错误，例如错别字、格式错误等。

|字数统计 | 原文路径 | 领取 | 状态 |
|------ | ----------------------------------------------------------- | --------------------------- | -----------------|
| 1236 | components/vfs/README.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成|
| 1431 | components/log/README.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成|
| 2826 | components/openssl/OpenSSL-APIs.rst | | |
| 582 | components/ulp/README.rst | | |
| 118 | components/expat/expat.rst | | |
| 2057 | components/nvs_flash/README.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成|
| 932 | components/wear_levelling/doc/wl_sw_structure.rst | | |
| 263 | components/wear_levelling/README.rst | | |
| 77 | components/bt/lib/README.rst | | |
| 56 | components/bootloader_support/README.rst | | |
| 77 | components/esp32/lib/README.rst | | |
| 1065 | components/spi_flash/README.rst | | |
| 252 | components/nghttp/nghttp.rst | | |
| 1319 | docs/api-guides/ulp.rst | | |
| 713 | docs/api-guides/deep-sleep-stub.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 39 | docs/api-guides/index.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 785 | docs/api-guides/core_dump.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 3 | docs/api-guides/ulp_macros.rst | [tidyjiang8](https://github.com/tidyjiang8) | 翻译中
| 4040 | docs/api-guides/build-system.rst | [tidyjiang8](https://github.com/tidyjiang8) | 翻译中
| 1242 | docs/api-guides/openocd.rst | [tidyjiang8](https://github.com/tidyjiang8) | 翻译中
| 1384 | docs/api-guides/partition-tables.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 3160 | docs/api-guides/ulp_instruction_set.rst | |
| 421 | docs/api-guides/unit-tests.rst | |
| 1857 | docs/api-guides/general-notes.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 100 | docs/resources.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 142 | docs/index.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 2565 | docs/security/secure-boot.rst | |
| 3735 | docs/security/flash-encryption.rst | |
| 401 | docs/get-started/make-project.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 283 | docs/get-started/add-idf_path-to-profile.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 759 | docs/get-started/idf-monitor.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 1474 | docs/get-started/index.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 283 | docs/get-started/linux-setup.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 217 | docs/get-started/linux-setup-scratch.rst | [tidyjiang8](https://github.com/tidyjiang8) |
| 191 | docs/get-started/macos-setup-scratch.rst | [tidyjiang8](https://github.com/tidyjiang8) |
| 180 | docs/get-started/macos-setup.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 702 | docs/get-started/eclipse-setup-windows.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 182 | docs/get-started/windows-setup.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 335 | docs/get-started/get-started-devkitc.rst | [tidyjiang8](https://github.com/tidyjiang8) |
| 638 | docs/get-started/windows-setup-scratch.rst | [tidyjiang8](https://github.com/tidyjiang8) |
| 863 | docs/get-started/eclipse-setup.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 1281 | docs/get-started/get-started-wrover-kit.rst | [tidyjiang8](https://github.com/tidyjiang8) |
| 589 | docs/get-started/establish-serial-connection.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 29 | docs/hw-reference/index.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 509 | docs/hw-reference/modules-and-boards.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 22 | docs/api-reference/index.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 26 | docs/api-reference/wifi/index.rst | [tidyjiang8](https://github.com/tidyjiang8) |
| 37 | docs/api-reference/wifi/esp_smartconfig.rst | [tidyjiang8](https://github.com/tidyjiang8) |
| 163 | docs/api-reference/wifi/esp_wifi.rst | [tidyjiang8](https://github.com/tidyjiang8) |
| 408 | docs/api-reference/template.rst | |
| 964 | docs/api-reference/peripherals/spi_master.rst | |
| 376 | docs/api-reference/peripherals/i2s.rst | |
| 66 | docs/api-reference/peripherals/sigmadelta.rst | |
| 151 | docs/api-reference/peripherals/dac.rst | |
| 165 | docs/api-reference/peripherals/i2c.rst | |
| 62 | docs/api-reference/peripherals/index.rst | |
| 208 | docs/api-reference/peripherals/uart.rst | |
| 833 | docs/api-reference/peripherals/spi_slave.rst | |
| 182 | docs/api-reference/peripherals/adc.rst | |
| 545 | docs/api-reference/peripherals/gpio.rst | |
| 223 | docs/api-reference/peripherals/ledc.rst | |
| 199 | docs/api-reference/peripherals/pcnt.rst | |
| 141 | docs/api-reference/peripherals/timer.rst | |
| 220 | docs/api-reference/peripherals/rmt.rst | |
| 41 | docs/api-reference/storage/index.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 597 | docs/api-reference/storage/sdmmc.rst | [tidyjiang8](https://github.com/tidyjiang8) |
| 464 | docs/api-reference/storage/fatfs.rst | [tidyjiang8](https://github.com/tidyjiang8) |
| 121 | docs/api-reference/storage/wear-levelling.rst | [tidyjiang8](https://github.com/tidyjiang8) |
| 457 | docs/api-reference/storage/spi_flash.rst | [tidyjiang8](https://github.com/tidyjiang8) |
| 78 | docs/api-reference/storage/vfs.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 332 | docs/api-reference/storage/nvs_flash.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 23 | docs/api-reference/ethernet/index.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 168 | docs/api-reference/ethernet/esp_eth.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 23 | docs/api-reference/protocols/index.rst | [tidyjiang8](https://github.com/tidyjiang8) |
| 756 | docs/api-reference/protocols/mdns.rst | [tidyjiang8](https://github.com/tidyjiang8) |
| 93 | docs/api-reference/bluetooth/esp_bt_defs.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 43 | docs/api-reference/bluetooth/esp_bt_device.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 51 | docs/api-reference/bluetooth/esp_bt_main.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 355 | docs/api-reference/bluetooth/esp_gap_ble.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 36 | docs/api-reference/bluetooth/index.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 20 | docs/api-reference/bluetooth/bt_common.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 97 | docs/api-reference/bluetooth/controller_vhci.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 202 | docs/api-reference/bluetooth/esp_gattc.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 40 | docs/api-reference/bluetooth/esp_gap_bt.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 252 | docs/api-reference/bluetooth/esp_blufi.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 358 | docs/api-reference/bluetooth/esp_gatt_defs.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 152 | docs/api-reference/bluetooth/esp_a2dp.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 26 | docs/api-reference/bluetooth/bt_le.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 216 | docs/api-reference/bluetooth/esp_gatts.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 76 | docs/api-reference/bluetooth/esp_avrc.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 17 | docs/api-reference/bluetooth/classic_bt.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 523 | docs/api-reference/system/wdts.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 40 | docs/api-reference/system/index.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 132 | docs/api-reference/system/log.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 376 | docs/api-reference/system/mem_alloc.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 1065 | docs/api-reference/system/deep_sleep.rst | [tidyjiang8](https://github.com/tidyjiang8) | 翻译中
| 908 | docs/api-reference/system/intr_alloc.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 348 | docs/api-reference/system/ota.rst | [tidyjiang8](https://github.com/tidyjiang8) | 完成
| 3 | docs/contribute/index.rst | |
| 873 | docs/contribute/style-guide.rst | |
| 1263 | docs/contribute/documenting-code.rst | |
| 1164 | docs/contribute/contributor-agreement.rst | |
| 83 | docs/about.rst | |
| 846 | docs/COPYRIGHT.rst | |
| 96 | examples/bluetooth/a2dp_sink/README.rst | |
| 86 | examples/bluetooth/gatt_server_service_table/README.rst | |
| 55 | examples/bluetooth/blufi/README.rst | |
| 88 | examples/bluetooth/gatt_security_server/README.rst | |
| 89 | examples/bluetooth/gatt_server/README.rst | |
| 21 | examples/bluetooth/ble_adv/README.rst | |
| 36 | examples/bluetooth/controller_hci_uart/README.rst | |
| 19 | examples/bluetooth/gatt_client/README.rst | |
| 304 | CONTRIBUTING.rst | |
## 翻译进度
- [PROCESS.md](PROCESS.md)

字数统计：共 59896 字。
## 贡献人员
- [tidyjiang8](https://github.com/tidyjiang8)

0 comments on commit 4df3bff

Please sign in to comment.