Skip to content

Commit b3e5c05

Browse files
committed
docs: Provide CN translation for two docs
1 parent d264866 commit b3e5c05

File tree

4 files changed

+197
-29
lines changed

4 files changed

+197
-29
lines changed

docs/en/debugproject.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
Debug Your Project
2-
===============================
2+
==================
3+
4+
:link_to_translation:`zh_CN:[中文]`
35

46
.. |debug_icon| image:: ../../media/icons/debug.png
57
:height: 16px
68
:align: middle
79

810
In most cases, only two things are required to start debugging an ESP-IDF project:
911

10-
1. Create a debug configuration
11-
2. Check whether the board in the created configuration corresponds to the board in use.
12+
1. Create a debug configuration.
13+
2. Check whether the board specified in the created configuration matches the board you are using.
14+
15+
.. note::
1216

13-
.. note::
1417
If you're using Windows, you may need to install drivers using Zadig to run a debug session successfully. For detailed instructions, please refer to this `guide <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/configure-ft2232h-jtag.html#configure-usb-drivers>`_.
1518

1619
The fastest way to create a debug configuration is as follows:

docs/en/windowsofflineinstaller.rst

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
Installing Espressif-IDE by Windows Offline Installer
44
======================================================
55

6+
:link_to_translation:`zh_CN:[中文]`
7+
68
`Espressif-IDE with ESP-IDF Windows Offline Installer` is an offline installer that includes all the required components for ESP-IDF application development.
79

810
The installer deploys the following components:
@@ -15,48 +17,48 @@ The installer deploys the following components:
1517
- Espressif-IDE
1618
- Amazon Corretto OpenJDK
1719

18-
As Installer bundles, all the required components and tools including stable esp-idf so people behind corporate firewalls can use the whole solution out-of-box. This also configures all the required build environment variables and tool paths as you launch the IDE. All you could do is to get started with your project directly without manually configuring anything. This will give you a big boost to your productivity!
20+
The installer bundles all the required components and tools, including a stable version of ESP-IDF, so that people working behind corporate firewalls can use the entire solution out of the box. This also configures all the required build environment variables and tool paths as you launch the IDE. All you need to do is start working on your project directly, without manually configuring anything. This will greatly boost your productivity!
1921

2022

2123
Download
2224
--------
2325

24-
You can download the latest version of the installer from `this <https://dl.espressif.com/dl/esp-idf/>`_ and run the installer. You can find installer name with ``Espressif-IDE-3.1.1 with ESP-IDF v5.3.1`` or similar name based on the version of the IDE and the version of the ESP-IDF.
26+
You can download the latest version of the installer from `this link <https://dl.espressif.com/dl/esp-idf/>`_ and run the installer. The installer name may look like ``Espressif-IDE-3.1.1 with ESP-IDF v5.3.1`` or something similar, depending on the version of the IDE and ESP-IDF.
2527

26-
Choose the Installer as shown below.
28+
Choose the installer as shown below.
2729

2830
.. image:: ../../media/windows-installation/ide_windows_installer_0.png
2931

3032
Installation
3133
------------
3234

33-
The installer is an executable file with .exe extension. You can run the installer by double-clicking on it.
35+
The installer is an executable file with ``.exe`` extension. You can run the installer by double-clicking on it.
3436

3537
The installer will guide you through the installation process. Please find the step-by-step guide below.
3638

3739
Step 1: Choose Language
38-
~~~~~~~~~~~~~~~~~~~~~~~~
40+
~~~~~~~~~~~~~~~~~~~~~~~
3941

40-
Select language for the installer and click Ok.
42+
Select language for the installer and click ``OK``.
4143

4244
.. image:: ../../media/windows-installation/ide_windows_installer_1.png
4345
:alt: drawing
4446

45-
Step 2: Accept the product license agreement
47+
Step 2: Accept the Product License Agreement
4648
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4749

48-
Read through the product license agreement, and then select `I accept the agreement`. You must accept the product license in order to continue with the installation. Continue by clicking Next.
50+
Read through the product license agreement, and then select ``I accept the agreement``. You must accept the product license in order to continue with the installation. Continue by clicking ``Next``.
4951

5052
.. image:: ../../media/windows-installation/ide_windows_installer_2.png
5153
:alt: drawing
5254

53-
Step 3: Pre-installation checks
55+
Step 3: Pre-Installation Checks
5456
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5557

5658
.. image:: ../../media/windows-installation/ide_windows_installer_3.png
5759
:alt: drawing
5860

59-
Step 4: Choose the installation directory
61+
Step 4: Choose the Installation Directory
6062
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6163

6264
.. image:: ../../media/windows-installation/ide_windows_installer_4.png
@@ -65,64 +67,64 @@ Step 4: Choose the installation directory
6567
Step 5: Select Components to Install
6668
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6769

68-
By default all the components are selected. You can deselect any component if you don't want to install it.
70+
By default, all components are selected. You can deselect any component that you dont want to install.
6971

7072
.. image:: ../../media/windows-installation/ide_windows_installer_5.png
7173
:alt: drawing
7274

73-
Step 6: Review the installation summary
75+
Step 6: Review the Installation Summary
7476
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7577

76-
A review summary is presented before the Espressif-IDE and others are installed.
78+
A summary for review is displayed before Espressif-IDE and other components are installed.
7779

7880
.. image:: ../../media/windows-installation/ide_windows_installer_6.png
7981
:alt: drawing
8082
.. image:: ../../media/windows-installation/ide_windows_installer_7.png
8183
:alt: drawing
8284

83-
Step 6: Finalize the installation
85+
Step 7: Finalize the Installation
8486
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8587

8688
.. image:: ../../media/windows-installation/ide_windows_installer_8.png
8789
:alt: drawing
8890
.. image:: ../../media/windows-installation/ide_windows_installer_9.png
8991
:alt: drawing
9092

91-
Step 7: Launch Espressif-IDE
93+
Step 8: Launch Espressif-IDE
9294
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9395

9496
Launch Espressif-IDE by double-clicking on the icon.
9597

9698
.. image:: ../../media/windows-installation/ide_windows_installer_10.png
9799
:alt: drawing
98100

99-
Step 8: Choose Espressif-IDE Workspace
101+
Step 9: Choose Espressif-IDE Workspace
100102
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
101103

102-
It's advised to select a workspace directory outside the Espressif-IDE Installer folder.
104+
It's advised to select a workspace directory outside the Espressif-IDE installer folder.
103105

104106
.. image:: ../../media/windows-installation/ide_windows_installer_11.png
105107
:alt: drawing
106108

107-
Step 9: Espressif-IDE Workbench
108-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
109+
Step 10: Espressif-IDE Workbench
110+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
109111

110-
As soon as you launch the Espressif-IDE, it will automatically configure the required environment variables and launch the Welcome page. You can close the Welcome page. You don't need to run any additional install tools from the IDE.
112+
As soon as you launch the Espressif-IDE, it will automatically configure the required environment variables and launch the Welcome page. You can close the Welcome page; there is no need to run any additional installation tools from the IDE.
111113

112114
.. image:: ../../media/windows-installation/ide_windows_installer_12.png
113115
:alt: drawing
114116

115-
You can verify the CDT Build environment variables from the Eclipse Preferences.
117+
You can verify the CDT Build environment variables from the Eclipse ``Preferences``.
116118

117119
.. image:: ../../media/windows-installation/ide_windows_installer_13.png
118120
:alt: drawing
119121

120-
Step 10: Build Your First Project
122+
Step 11: Build Your First Project
121123
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
122124

123125
As IDE already configured with all the required environment variables, you can start with your project.
124126

125-
You can find more details for creating a project in the :ref:`New Project <startproject>` section of the documentation.
127+
You can find more details for creating a project in the :ref:`Start a Project <startproject>` section of the documentation.
126128

127129
.. image:: ../../media/windows-installation/ide_windows_installer_14.png
128130
:alt: drawing

docs/zh_CN/debugproject.rst

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,35 @@
1-
.. include:: ../en/debugproject.rst
1+
调试项目
2+
========
3+
4+
:link_to_translation:`en:[English]`
5+
6+
.. |debug_icon| image:: ../../media/icons/debug.png
7+
:height: 16px
8+
:align: middle
9+
10+
在大多数情况下,开始调试一个 ESP-IDF 项目只需要完成以下两步:
11+
12+
1. 创建调试配置。
13+
2. 检查已创建配置中指定的开发板是否与实际使用的开发板一致。
14+
15+
.. note::
16+
17+
如果使用 Windows 操作系统,可能需要通过 Zadig 安装驱动程序,才能成功运行调试会话。有关详细说明,请参考此 `指南 <https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/api-guides/jtag-debugging/configure-ft2232h-jtag.html#usb>`_。
18+
19+
创建调试配置的最快方式如下:
20+
21+
1. 在启动栏中展开配置列表并点击 ``New Launch Configuration...``。
22+
2. 选择 ``ESP-IDF GDB OpenOCD Debugging``,然后双击该选项或点击 ``Next``。
23+
3. 上述选项会打开新的调试配置预览界面,用于查看开发板设置。
24+
25+
创建调试配置后,即可继续调试该项目:
26+
27+
1. 选择刚才创建的配置。
28+
2. 选择 ``Debug`` 模式。
29+
3. 点击 ``Debug`` 图标 |debug_icon| 以开始调试。
30+
31+
32+
.. image:: https://github.com/espressif/idf-eclipse-plugin/assets/24419842/1fb0fb9b-a02a-4ed1-bdba-b4b4d36d100f
33+
:alt: 调试过程
34+
35+
要了解更多有关调试配置的内容,请参阅 :ref:`ESP-IDF OpenOCD 调试 <OpenOCDDebugging>`。
Lines changed: 130 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,130 @@
1-
.. include:: ../en/windowsofflineinstaller.rst
1+
.. _windowsofflineinstaller:
2+
3+
通过 Windows 离线安装程序安装 Espressif-IDE
4+
======================================================
5+
6+
:link_to_translation:`en:[English]`
7+
8+
`Espressif-IDE with ESP-IDF Windows Offline Installer` 是一个离线安装程序,包含进行 ESP-IDF 应用开发所需的全部组件。
9+
10+
安装程序会部署以下组件:
11+
12+
- 内置 Python
13+
- 交叉编译器
14+
- OpenOCD
15+
- CMake 和 Ninja 构建工具
16+
- ESP-IDF
17+
- Espressif-IDE
18+
- Amazon Corretto OpenJDK
19+
20+
安装程序打包了包括稳定版本的 ESP-IDF在内的所有必要组件和工具,处于企业防火墙内的用户也可以开箱即用整套方案。安装程序还会在启动 IDE 时自动配置所有必要的构建环境变量和工具路径。只需直接开始项目即可,无需手动进行任何配置。这将大大提升你的工作效率!
21+
22+
下载
23+
----
24+
25+
可以点击 `此链接 <https://dl.espressif.com/dl/esp-idf/>`_ 下载最新版安装程序并运行。安装程序的名称可能类似于 ``Espressif-IDE-3.1.1 with ESP-IDF v5.3.1``,具体名称取决于 IDE 和 ESP-IDF 的版本。
26+
27+
按下图所示选择安装程序。
28+
29+
.. image:: ../../media/windows-installation/ide_windows_installer_0.png
30+
31+
安装
32+
----
33+
34+
安装程序是一个带有 ``.exe`` 扩展名的可执行文件,双击即可运行。
35+
36+
安装程序会引导你完成安装过程,请参阅下面的分步指南。
37+
38+
步骤 1:选择语言
39+
~~~~~~~~~~~~~~~~~~
40+
41+
选择安装程序的语种,然后点击 ``OK``。
42+
43+
.. image:: ../../media/windows-installation/ide_windows_installer_1.png
44+
:alt: 示意图
45+
46+
步骤 2:接受产品许可协议
47+
~~~~~~~~~~~~~~~~~~~~~~~~~~
48+
49+
阅读产品许可协议,然后选择 ``I accept the agreement``。必须接受产品许可才能继续安装。点击 ``Next`` 进行下一步操作。
50+
51+
.. image:: ../../media/windows-installation/ide_windows_installer_2.png
52+
:alt: 示意图
53+
54+
步骤 3:安装前的检查
55+
~~~~~~~~~~~~~~~~~~~~~~
56+
57+
.. image:: ../../media/windows-installation/ide_windows_installer_3.png
58+
:alt: 示意图
59+
60+
步骤 4:选择安装目录
61+
~~~~~~~~~~~~~~~~~~~~~~
62+
63+
.. image:: ../../media/windows-installation/ide_windows_installer_4.png
64+
:alt: 示意图
65+
66+
步骤 5:选择要安装的组件
67+
~~~~~~~~~~~~~~~~~~~~~~~~
68+
69+
默认情况下,所有组件都会被选中。如果你不想安装某个组件,可以取消选中它。
70+
71+
.. image:: ../../media/windows-installation/ide_windows_installer_5.png
72+
:alt: 示意图
73+
74+
步骤 6:检查安装摘要
75+
~~~~~~~~~~~~~~~~~~~~~
76+
77+
在安装 Espressif-IDE 等组件之前会显示一份摘要以供检查。
78+
79+
.. image:: ../../media/windows-installation/ide_windows_installer_6.png
80+
:alt: 示意图
81+
.. image:: ../../media/windows-installation/ide_windows_installer_7.png
82+
:alt: 示意图
83+
84+
步骤 7:完成安装
85+
~~~~~~~~~~~~~~~~
86+
87+
.. image:: ../../media/windows-installation/ide_windows_installer_8.png
88+
:alt: 示意图
89+
.. image:: ../../media/windows-installation/ide_windows_installer_9.png
90+
:alt: 示意图
91+
92+
步骤 8:启动 Espressif-IDE
93+
~~~~~~~~~~~~~~~~~~~~~~~~~~
94+
95+
双击图标以启动 Espressif-IDE。
96+
97+
.. image:: ../../media/windows-installation/ide_windows_installer_10.png
98+
:alt: 示意图
99+
100+
步骤 9:选择 Espressif-IDE 工作区
101+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
102+
103+
建议在 Espressif-IDE 安装程序文件夹之外选择一个工作区目录。
104+
105+
.. image:: ../../media/windows-installation/ide_windows_installer_11.png
106+
:alt: 示意图
107+
108+
步骤 10:Espressif-IDE 工作台
109+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
110+
111+
启动 Espressif-IDE 后,会自动配置所需的环境变量并打开欢迎页面。你可以关闭欢迎页面,无需在 IDE 中运行任何额外的安装工具。
112+
113+
.. image:: ../../media/windows-installation/ide_windows_installer_12.png
114+
:alt: 示意图
115+
116+
可以在 Eclipse ``Preferences`` 中查看 CDT 构建环境变量。
117+
118+
.. image:: ../../media/windows-installation/ide_windows_installer_13.png
119+
:alt: 示意图
120+
121+
步骤 11:构建首个项目
122+
~~~~~~~~~~~~~~~~~~~~~~
123+
124+
IDE 已经配置好所有必要的环境变量,可以直接开始项目。
125+
126+
有关创建项目的更多详细信息,请参阅文档中的 :ref:`开始项目 <startproject>` 章节。
127+
128+
.. image:: ../../media/windows-installation/ide_windows_installer_14.png
129+
:alt: 示意图
130+
:width: 400

0 commit comments

Comments
 (0)