alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
esp-idf/docs/zh_CN/get-started/index.rst

177 lines
5.6 KiB
ReStructuredText
Raw Normal View History

Add translation for getting started guide - batch 1
2019-10-10 16:52:07 +08:00
***********
快速入门
***********
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
:link_to_translation:`en:[English]`
add CN translation for index.rst in get started section for MR10616
2020-12-03 15:26:17 +08:00
.. 请保证 README.md 文件与该文件保持同步
doc: Changed Chinese doc to use dynamic chip name
2019-12-10 14:55:35 +08:00
本文档旨在指导用户搭建 {IDF_TARGET_NAME} 硬件开发的软件环境，通过一个简单的示例展示如何使用 ESP-IDF (Espressif IoT Development Framework) 配置菜单，并编译、下载固件至 {IDF_TARGET_NAME} 开发板等步骤。
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
docs: add new top-level docs builder that builds docs for a single chip
2019-11-13 11:46:16 +08:00
.. include-build-file:: inc/version-note.inc
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
概述
Add translation for getting started guide - batch 1
2019-10-10 16:52:07 +08:00
============
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
docs: update all documents in get started section and keep line number consistent
2021-07-22 15:54:47 +08:00
{IDF_TARGET_NAME} SoC 芯片支持以下功能：
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
docs: update all documents in get started section and keep line number consistent
2021-07-22 15:54:47 +08:00
.. only:: esp32
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
doc: Changed Chinese doc to use dynamic chip name
2019-12-10 14:55:35 +08:00
* 2.4 GHz Wi-Fi
Updated CN translation for index.rst and establish-serial-connection.rst and add CN translation for VScode-setup.rst in get-started folder to get EN and CN translation in sync
2020-11-25 14:45:26 +08:00
* 蓝牙
Provide CN translation for part of documents in MR11884
2021-02-02 09:19:58 +08:00
* 高性能 Xtensa® 32 位 LX6 双核处理器
doc: Changed Chinese doc to use dynamic chip name
2019-12-10 14:55:35 +08:00
* 超低功耗协处理器
* 多种外设
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
add CN translation for index.rst in get started section for MR10616
2020-12-03 15:26:17 +08:00
.. only:: esp32s2
doc: Changed Chinese doc to use dynamic chip name
2019-12-10 14:55:35 +08:00
* 2.4 GHz Wi-Fi
Provide CN translation for part of documents in MR11884
2021-02-02 09:19:58 +08:00
* 高性能 Xtensa® 32 位 LX7 单核处理器
Updated CN translation for index.rst and establish-serial-connection.rst and add CN translation for VScode-setup.rst in get-started folder to get EN and CN translation in sync
2020-11-25 14:45:26 +08:00
* 运行 RISC-V 或 FSM 内核的超低功耗协处理器
doc: Changed Chinese doc to use dynamic chip name
2019-12-10 14:55:35 +08:00
* 多种外设
Updated CN translation for index.rst and establish-serial-connection.rst and add CN translation for VScode-setup.rst in get-started folder to get EN and CN translation in sync
2020-11-25 14:45:26 +08:00
* 内置安全硬件
* USB OTG 接口
doc: Changed Chinese doc to use dynamic chip name
2019-12-10 14:55:35 +08:00
docs: translate ESP32-S3 get started
2021-06-30 18:05:36 +08:00
.. only:: esp32s3
* 2.4 GHz Wi-Fi
* 低功耗蓝牙
* 高性能 Xtensa® 32 位 LX7 双核处理器
* 运行 RISC-V 或 FSM 内核的超低功耗协处理器
* 多种外设
* 内置安全硬件
* USB OTG 接口
* USB 串口/JTAG 控制器
Provide CN translation for part of documents in MR11884
2021-02-02 09:19:58 +08:00
.. only:: esp32c3
* 2.4 GHz Wi-Fi
docs: translate ESP32-S3 get started
2021-06-30 18:05:36 +08:00
* 低功耗蓝牙
Provide CN translation for part of documents in MR11884
2021-02-02 09:19:58 +08:00
* 高性能 32 位 RISC-V 单核处理器
* 多种外设
* 内置安全硬件
docs: update getting started guide for C2
2022-05-19 23:22:24 +08:00
.. only:: esp32c2
* 2.4 GHz Wi-Fi
* 低功耗蓝牙
* 高性能 32 位 RISC-V 单核处理器
* 多种外设
* 适用于较简单、大批量生产的物联网应用
docs: update all documents in get started section and keep line number consistent
2021-07-22 15:54:47 +08:00
{IDF_TARGET_NAME} 采用 40 nm 工艺制成，具有最佳的功耗性能、射频性能、稳定性、通用性和可靠性，适用于各种应用场景和不同功耗需求。
乐鑫为用户提供完整的软、硬件资源，进行 {IDF_TARGET_NAME} 硬件设备的开发。其中，乐鑫的软件开发环境 ESP-IDF 旨在协助用户快速开发物联网 (IoT) 应用，可满足用户对 Wi-Fi、蓝牙、低功耗等方面的要求。
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
准备工作
Add translation for getting started guide - batch 1
2019-10-10 16:52:07 +08:00
=============
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
硬件：
docs: updated CN translation for new get started
2022-01-15 20:29:02 +08:00
~~~~~~~~~~~~~~~~
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
doc: Changed Chinese doc to use dynamic chip name
2019-12-10 14:55:35 +08:00
* 一款 **{IDF_TARGET_NAME}** 开发板
Add translation for getting started guide - batch 1
2019-10-10 16:52:07 +08:00
* **USB 数据线** (A 转 Micro-B)
docs: updated CN translation for new get started
2022-01-15 20:29:02 +08:00
* 电脑（Windows、Linux 或 macOS）
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
docs: updated CN translation for new get started
2022-01-15 20:29:02 +08:00
.. note:: 目前一些开发板使用的是 USB Type C 接口。请确保使用合适的数据线来连接开发板!
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
docs: updated CN translation for new get started
2022-01-15 20:29:02 +08:00
以下是 {IDF_TARGET_NAME} 官方开发板，点击链接可了解更多硬件信息。
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
doc: Changed Chinese doc to use dynamic chip name
2019-12-10 14:55:35 +08:00
.. only:: esp32
.. toctree::
:maxdepth: 1
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
doc: Split HW-Reference into seperate files/folders for different chips
2019-12-11 15:45:30 +08:00
ESP32-DevKitC <../hw-reference/esp32/get-started-devkitc>
ESP-WROVER-KIT <../hw-reference/esp32/get-started-wrover-kit>
ESP32-PICO-KIT <../hw-reference/esp32/get-started-pico-kit>
ESP32-Ethernet-Kit <../hw-reference/esp32/get-started-ethernet-kit>
Updated index components/esp_wifi/lib_esp32/
2020-03-11 06:43:31 +08:00
ESP32-DevKit-S(-R) <../hw-reference/esp32/user-guide-devkits-r-v1.1>
upload user guide for development board: ESP32-PICO-KIT-1
2020-10-13 13:33:43 +08:00
ESP32-PICO-KIT-1 <../hw-reference/esp32/get-started-pico-kit-1>
provide user guide for the development board ESP32-PICO-DevKitM-2
2020-10-14 10:21:25 +08:00
ESP32-PICO-DevKitM-2 <../hw-reference/esp32/get-started-pico-devkitm-2>
provide user guide for ESP32-DevKitM-1
2021-01-05 12:32:08 +08:00
ESP32-DevKitM-1 <../hw-reference/esp32/user-guide-devkitm-1>
Updated CN translation for index.rst and establish-serial-connection.rst and add CN translation for VScode-setup.rst in get-started folder to get EN and CN translation in sync
2020-11-25 14:45:26 +08:00
Add ESP32-S2-Saola-1 User Guide
2020-03-26 18:40:05 +08:00
.. only:: esp32s2
.. toctree::
:maxdepth: 1
upload user guide for development board: ESP32-PICO-KIT-1
2020-10-13 13:33:43 +08:00
Add ESP32-S2-Saola-1 User Guide
2020-03-26 18:40:05 +08:00
ESP32-S2-Saola-1 <../hw-reference/esp32s2/user-guide-saola-1-v1.2>
Add ESP32-S2-DevKitM-1 User Guide Update 1 based on comments Fix typo Add annotation to UFL connector Add UFL connector to description table
2020-10-12 18:03:51 +08:00
ESP32-S2-DevKitM-1(U) <../hw-reference/esp32s2/user-guide-devkitm-1-v1>
docs/add_esp32-s2-devkitc-1_user_guide
2021-07-22 19:50:53 +08:00
ESP32-S2-DevKitC-1 <../hw-reference/esp32s2/user-guide-s2-devkitc-1>
Add user guides for ESP32-S2-Kaluga-1-Kit
2020-05-08 20:27:34 +08:00
ESP32-S2-Kaluga-Kit <../hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit>
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
Provide CN translation for part of documents in MR11884
2021-02-02 09:19:58 +08:00
.. only:: esp32c3
Add ESP32-C3-DevKitM-1 User Guide and updated ESP32C3_DOCS
2021-02-05 12:00:40 +08:00
.. toctree::
:maxdepth: 1
Provide CN translation for part of documents in MR11884
2021-02-02 09:19:58 +08:00
Add ESP32-C3-DevKitM-1 User Guide and updated ESP32C3_DOCS
2021-02-05 12:00:40 +08:00
ESP32-C3-DevKitM-1 <../hw-reference/esp32c3/user-guide-devkitm-1>
Add ESP32-C3-DevKitC-02 User Guide
2021-03-10 19:39:55 +08:00
ESP32-C3-DevKitC-02 <../hw-reference/esp32c3/user-guide-devkitc-02>
Provide CN translation for part of documents in MR11884
2021-02-02 09:19:58 +08:00
docs: translate ESP32-S3 get started
2021-06-30 18:05:36 +08:00
docs:add esp32-s3-devkitc-1 user guide
2021-06-22 16:55:32 +08:00
.. only:: esp32s3
.. toctree::
:maxdepth: 1
ESP32-S3-DevKitC-1 <../hw-reference/esp32s3/user-guide-devkitc-1>
Doc/add esp32s3 kevkitm 1 user guide cn and en
2021-11-17 11:13:34 +00:00
ESP32-S3-DevKitM-1 <../hw-reference/esp32s3/user-guide-devkitm-1>
docs:add esp32-s3-devkitc-1 user guide
2021-06-22 16:55:32 +08:00
docs: update getting started guide for C2
2022-05-19 23:22:24 +08:00
.. only:: esp32c2
.. toctree::
:maxdepth: 1
ESP8684-DevKitM-1 <https://docs.espressif.com/projects/espressif-esp-dev-kits/zh_CN/latest/esp8684/esp8684-devkitm-1/index.html>
Add translation for getting started guide - batch 1
2019-10-10 16:52:07 +08:00
.. _get-started-get-prerequisites:
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
docs: updated CN translation for new get started
2022-01-15 20:29:02 +08:00
软件：
~~~~~~~~
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
docs: updated CN translation for new get started
2022-01-15 20:29:02 +08:00
如需在 **{IDF_TARGET_NAME}** 上使用 ESP-IDF，请安装以下软件：
docs: update esp32s2 summary page - Refer to the toolchain links on IDF Tools page - Update the wording around v4.1/v4.2 releases - Remove the section about 3 different versions (of S2-beta) - Add link to the list of features maintained externally
2020-02-18 12:06:27 +01:00
docs: updated CN translation for new get started
2022-01-15 20:29:02 +08:00
* 设置 **工具链**，用于编译 {IDF_TARGET_NAME} 代码；
* **编译构建工具** —— CMake 和 Ninja 编译构建工具，用于编译 {IDF_TARGET_NAME} **应用程序**；
* 获取 **ESP-IDF** 软件开发框架。该框架已经基本包含 {IDF_TARGET_NAME} 使用的 API（软件库和源代码）和运行 **工具链** 的脚本；
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
docs: updated CN translation for new get started
2022-01-15 20:29:02 +08:00
.. figure:: ../../_static/what-you-need.png
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
:align: center
docs: updated CN translation for new get started
2022-01-15 20:29:02 +08:00
:alt: Development of applications for {IDF_TARGET_NAME}
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
:figclass: align-center
docs: updated CN translation for new get started
2022-01-15 20:29:02 +08:00
.. _get-started-step-by-step:
.. _get-started-how-to-get-esp-idf:
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
docs: updated CN translation for new get started
2022-01-15 20:29:02 +08:00
安装
============
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
docs: updated CN translation for new get started
2022-01-15 20:29:02 +08:00
我们提供以下方法帮助安装所有需要的软件，可根据需要选择其中之一。
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
docs: updated CN translation for new get started
2022-01-15 20:29:02 +08:00
IDE
~~~~~~
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
docs: updated CN translation for new get started
2022-01-15 20:29:02 +08:00
.. note:: 建议您通过自己喜欢的集成开发环境 (IDE) 安装 ESP-IDF。
Updated CN translation for index.rst and establish-serial-connection.rst and add CN translation for VScode-setup.rst in get-started folder to get EN and CN translation in sync
2020-11-25 14:45:26 +08:00
docs: deleted IDE documentation and provided links to these IDE GitHub repos
2022-06-22 16:51:31 +08:00
* `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README.md>`_
* `VSCode Extension <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_
Updated CN translation for index.rst and establish-serial-connection.rst and add CN translation for VScode-setup.rst in get-started folder to get EN and CN translation in sync
2020-11-25 14:45:26 +08:00
docs: updated CN translation for new get started
2022-01-15 20:29:02 +08:00
手动安装
~~~~~~~~~~~~~~~~~~~
Updated CN translation for index.rst and establish-serial-connection.rst and add CN translation for VScode-setup.rst in get-started folder to get EN and CN translation in sync
2020-11-25 14:45:26 +08:00
docs: updated CN translation for new get started
2022-01-15 20:29:02 +08:00
请根据您的操作系统选择对应的手动安装流程。
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
[Docs] Rebase conlicts fixed [Docs] New getting started based on the ide and os selection Missing file on zh_CN folder added Added hidden toctree for missing files in CN version docs: Added steps summary to the macOS procedures [Docs] Changes on the titles and heading levels [Docs] Review according to MR 15432 [Docs] Fixed the start a new project secction
2022-02-14 10:17:08 +00:00
.. toctree::
docs: updated CN translation for new get started
2022-01-15 20:29:02 +08:00
:maxdepth: 1
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
docs: fix getting started having 2 toctrees Instead of having 2 toctrees for setup and build your first project parts, use os-specific refs for the build your first project part
2022-04-15 16:26:21 +02:00
Windows Installer <windows-setup>
Linux and macOS <linux-macos-setup>
Add translation for getting started guide - batch 1
2019-10-10 16:52:07 +08:00
docs: updated CN translation for new get started
2022-01-15 20:29:02 +08:00
编译第一个工程
===================
Add translation for getting started guide - batch 1
2019-10-10 16:52:07 +08:00
docs: sync up lines for api-guides and get-started
2022-05-07 17:15:18 +08:00
如果您已经安装好 ESP-IDF 且没有使用集成开发环境 (IDE)，请在命令提示行中按照 :ref:`在 Windows 中开始创建工程 <get-started-windows-first-steps>` 或 :ref:`在 Linux 和 macOS 中开始创建工程 <get-started-linux-macos-first-steps>` 编译第一个工程。
Fix regression in docs build failure
2022-02-20 14:15:43 +05:30
.. _Stable version: https://docs.espressif.com/projects/esp-idf/en/stable/
Reference in New Issue Copy Permalink