请选择 进入手机版 | 继续访问电脑版
论坛
登录 | 立即注册 设为首页收藏本站 切换到宽版
查看: 4676|回复: 1

【超级福利】ESP-IDF 编程指南-中文版

[复制链接]

1

主题

1

帖子

30

积分

新手上路

Rank: 1

积分
30
发表于 2017-7-28 11:32:48 | 显示全部楼层 |阅读模式
本帖最后由 tidyjiang8 于 2017-8-9 16:24 编辑

ESP-IDF 是乐鑫为 ESP32 设计的 IoT 开发框架,是我们开发 ESP32 应用程序的必经之路。

乐鑫为 ESP-IDF 编写了非常完善的配套文档,该文档涵盖了各个平台开发环境的搭建,API 接口的使用,各个功能模块的说明,贡献代码的流程等等细节,为我们学习掌握 ESP32 提供了捷径。

不过,非常遗憾的是,该文档是纯英文的,增加了许多对英文不熟练的初学者的学习门槛。为此,我在业余时间将它翻译成了中文,希望能给大家带来一丁点的帮助。
文档是如何翻译的?

很多小伙伴儿一直都非常好奇,我是如何将翻译后的文档转换成网页并托管到网站上的?这么机密的事情,一般人我会告诉他吗?不过大家都不是一般人,我还是说说具体的做法。

细心你的可能会发现,在 ESP-IDF 仓库源码中存在一个叫做 docs 的神奇目录,然看再看看该目录下的文件,发现其内容与 ESP-IDF 网页上的内容非常相似。没错,发现新大陆了,这就是网站整个文档的源代码!

再次进入 docs 目录及其子目录,发现很多文件都是以后缀 .rst 结尾的,这就是 reStructuredText 文档的源代码。reStructuredText 又是神马呢?reStructuredText 是一种非常简单的标记语言,许多开源项目都使用 reStructuredText 来编写说明文档,我们的 ESP-IDF 就是其中之一。

另外,Zephyr OS 也是使用该语言来编写文档的,请参考 Zephyr 的仓库 https://github.com/zephyrproject-rtos/zephyr/
.rst 文档具体是如何转换成网页的呢?这里就不详述了,有兴趣的小伙伴可以参考这篇文章 使用 sphinx 制作简洁而又美观的文档,或者自行百度”sphinx 编写文档”。

一起参与翻译


个人的时间、精力以及能力都非常有限,希望有兴趣的小伙伴儿可以参与到这个翻译的过程中来,一边翻译一边学习,一起完善这个文档。

具体的翻译步骤请参考【贡献流程】。

发现错误

如果细心的你在阅读中文文档的过程中发现有错别字、语句不通顺或者原文理解错误的,请按照如下方式进行指正:

  • 方式一: 参考【贡献流程】,修改文档对应的源码,并提交 Pull Request。【推荐】
  • 方式二: 在 这里 提出问题。
  • 方式三: 在本文评论留言。
  • 方式四: 给我发送 e-mail: tidyjiang@163.com

项目链接


说明

当前的文档对应的 ESP-IDF 版本是 v2.0,后期将会继续翻译新版本。




                         
         
回复

使用道具 举报

0

主题

0

帖子

19

积分

新手上路

Rank: 1

积分
19
发表于 2018-5-18 09:47:09 | 显示全部楼层
非常支持。而且看了。希望作者再接再励
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

手机版|小黑屋|安信可论坛    

GMT+8, 2018-12-15 18:09 , Processed in 0.022555 second(s), 12 queries , Redis On.

Powered by Discuz! X3.3

© 2001-2017 Comsenz Inc.

快速回复 返回顶部 返回列表