diff --git a/docs_espressif/en/index.rst b/docs_espressif/en/index.rst index 02bccbd7b..4a1bd92f3 100644 --- a/docs_espressif/en/index.rst +++ b/docs_espressif/en/index.rst @@ -9,11 +9,11 @@ The ESP-IDF extension for VSCode Code empowers developers to efficiently develop :maxdepth: 1 Prerequisites - Installation + Install ESP-IDF and Tools Start a Project Connect Your Device Configure Your Project - Build the Project + Build Your Project Flash onto the Device Monitor the Output Debug Your Project diff --git a/docs_espressif/en/prerequisites.rst b/docs_espressif/en/prerequisites.rst index 2a0f63736..6a7570c37 100644 --- a/docs_espressif/en/prerequisites.rst +++ b/docs_espressif/en/prerequisites.rst @@ -1,19 +1,25 @@ Prerequisites -=============================== -The minimum requirements for running the ESP-IDF Extension with the VSCode are below. +============= -- `Visual Studio Code `_. +:link_to_translation:`zh_CN:[中文]` + +You need to install some software packages and tools based on your operating system. Windows -------------------------------- +------- + +- `Visual Studio Code `_ + +.. note:: -No additional prerequisites required, the installation step will take care of the rest. + No additional prerequisites are required. The :ref:`installation ` step will handle the rest. -MacOS/Linux -------------------------------- +macOS/Linux +----------- -- `Python 3.12 `_ and above. -- `Git `_. -- Install the following `ESP-IDF Prerequisites `_. +- `Visual Studio Code `_ +- `Python 3.12 `_ and above +- `Git `_ +- `ESP-IDF Prerequisites `_ -Next proceed to :ref:`Install ESP-IDF and Tools `. \ No newline at end of file +Next, proceed to :ref:`Install ESP-IDF and Tools `. diff --git a/docs_espressif/zh_CN/index.rst b/docs_espressif/zh_CN/index.rst index bf995c360..5e6dfd06c 100644 --- a/docs_espressif/zh_CN/index.rst +++ b/docs_espressif/zh_CN/index.rst @@ -8,8 +8,8 @@ .. toctree:: :maxdepth: 1 - 安装包 - 安装 + 准备工作 + 安装 ESP-IDF 和工具 启动项目 连接设备 配置项目 @@ -21,7 +21,7 @@ 故障排除 设置 可用命令列表 - FAQs + 常见问题 功能 ---- diff --git a/docs_espressif/zh_CN/prerequisites.rst b/docs_espressif/zh_CN/prerequisites.rst index 615f6604e..849231baf 100644 --- a/docs_espressif/zh_CN/prerequisites.rst +++ b/docs_espressif/zh_CN/prerequisites.rst @@ -1 +1,25 @@ -.. include:: ../en/prerequisites.rst \ No newline at end of file +准备工作 +======== + +:link_to_translation:`en:[English]` + +请根据操作系统,安装相应的软件包和工具。 + +Windows +------- + +- `Visual Studio Code `_。 + +.. note:: + + 无需额外的准备,:ref:`安装 ` 步骤将准备好一切所需工具。 + +macOS/Linux +----------- + +- `Visual Studio Code `_ +- `Python 3.12 `_ 及以上版本 +- `Git `_ +- `ESP-IDF 安装准备 `_ + +接下来,请参考 :ref:`安装 ESP-IDF 和工具 `。