Skip to content

Commit fd88002

Browse files
Shen7436Shen7436
committed
docs: Provide CN translation for two docs (#1347)
1 parent 02b7aa4 commit fd88002

File tree

4 files changed

+257
-82
lines changed

4 files changed

+257
-82
lines changed

‎docs/en/buildproject.rst‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
Build the Project
2-
===============================
1+
Build Your Project
2+
==================
3+
4+
:link_to_translation:`zh_CN:[中文]`
35

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

10+
Once you have created a project and configured the ESP target and serial port, you can build the project by clicking on |build_icon| in the toolbar.
811

9-
Once you have created a project and configured the esp target and serial port, you can build the project by clicking on |build_icon| in the toolbar.
10-
11-
However, below steps will guide you through the process of building the project if you are new to the IDE:
12+
However, the following steps will guide you through the process of building the project if you are new to the IDE:
1213

1314
1. Select a project from the ``Project Explorer``.
14-
2. Select ``Run`` from the first dropdown, which is called `Launch Mode`.
15-
3. Select your application from the second dropdown, which is called `Launch Configuration` (Auto-detected).
16-
4. Select a target from the third dropdown, for example, ``esp32``, which is called `Launch Target`.
15+
2. Select ``Run`` from the first dropdown, which is called **Launch Mode**.
16+
3. Select your application from the second dropdown, which is called **Launch Configuration** (Auto-detected).
17+
4. Select a target from the third dropdown, which is called **Launch Target**. For example, ``esp32``.
1718
5. Now click on the ``Build`` button |build_icon| to start the build process.
1819

19-
20-
.. image:: ../../media/9_cmake_build.png
20+
.. image:: ../../media/9_cmake_build.png
2121

2222
Custom Build Directory
2323
----------------------
@@ -30,16 +30,17 @@ The IDE allows configuring a custom build directory for the project:
3030
4. Click on ``Ok`` and build the project.
3131

3232
.. note::
33-
This configuration changes where all the project build artifacts will be generated.
33+
34+
This configuration specifies the location where all the project build artifacts will be generated.
3435

3536
.. image:: ../../media/custombuilddir.png
3637
:alt: Custom Build Directory Configuration
3738

3839
References
3940
----------
41+
4042
.. toctree::
4143
:maxdepth: 1
4244

4345
Configure CDT Build Environment Variables <additionalfeatures/configureenvvariables>
4446
Add a Preview or Custom ESP-IDF Target <additionalfeatures/configuretoolchain>
45-

‎docs/en/marketplaceupdate.rst‎

Lines changed: 62 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,40 @@
11
.. _marketplaceupdate:
22

33
Update Site Installation Guide
4-
======================================
4+
==============================
55

6-
The Espressif-IDE Eclipse Plugin can be installed using the update site URL, Eclipse Marketplace, or a local archive. This guide provides instructions for each method.
6+
:link_to_translation:`zh_CN:[中文]`
7+
8+
The Espressif-IDE Eclipse Plugin can be installed using the following three methods:
79

810
- :ref:`installUpdateSiteURL`
911
- :ref:`install_idf_eclipse_plugin_marketplace`
1012
- :ref:`install_idf_eclipse_plugin_local_archive`
11-
- :ref:`upgradePlugins`
12-
- :ref:`upgradeEspressifIdeDependencies`
13-
- :ref:`troubleshooting_missing_items`
1413

1514
.. _installUpdateSiteURL:
1615

17-
Installing IDF Plugin using update site URL
18-
--------------------------------------------
16+
Installing IDF Plugin Using the Update Site URL
17+
-----------------------------------------------
18+
1919
You can install the IDF Eclipse plugin into an existing Eclipse CDT/Espressif-IDE using the update site URL. First, add the release repository URL as follows:
2020

21-
1. Go to ``Help`` > ``Install New Software``.
22-
2. Click `Add…`, and in the pop-up window:
23-
* Enter `Name` as `Espressif IDF Plugin for Eclipse`.
24-
* Enter `Location` of the repository
25-
* For the stable release: `<https://dl.espressif.com/dl/idf-eclipse-plugin/updates/latest/>`_.
26-
* Click `Add`.
27-
3. Select all from the list and proceed with the installation.
21+
1. Go to ``Help`` > ``Install New Software``.
22+
2. Click ``Add``, and in the pop-up window:
23+
24+
* Enter ``Espressif IDF Plugin for Eclipse`` as the ``Name``.
25+
* Enter ``Location`` of the repository. (`Stable release <https://dl.espressif.com/dl/idf-eclipse-plugin/updates/latest/>`_)
26+
* Click ``Add``.
27+
28+
3. Select all items from the list and proceed with the installation.
2829

2930
For adding beta and nightly builds, you can use the following update site URLs:
30-
* For Beta version: `<https://dl.espressif.com/dl/idf-eclipse-plugin/updates/beta/>`_.
31-
* For Nightly build: `<https://dl.espressif.com/dl/idf-eclipse-plugin/updates/nightly/>`_.
31+
32+
* `Beta version <https://dl.espressif.com/dl/idf-eclipse-plugin/updates/beta/>`_
33+
* `Nightly build <https://dl.espressif.com/dl/idf-eclipse-plugin/updates/nightly/>`_
3234

3335
.. note::
34-
While the screenshots are captured on macOS, the installation instructions are applicable to Windows, Linux, and macOS.
36+
37+
Although the following screenshots are captured on macOS, the installation steps are the same for Windows and Linux.
3538

3639
.. image:: ../../media/idf_update_site_install.png
3740

@@ -43,100 +46,91 @@ Installing IDF Eclipse Plugin from Eclipse Marketplace
4346

4447
To install the ESP-IDF Eclipse Plugin from the Eclipse Marketplace, follow these steps:
4548

46-
1. Open Eclipse and go to `Help` > `Eclipse Marketplace...`.
47-
49+
1. Open Eclipse and go to ``Help`` > ``Eclipse Marketplace...``.
4850
2. In the search box, enter **ESP-IDF Eclipse Plugin** to locate the plugin.
49-
50-
3. Click **Install** and follow the on-screen instructions to complete the installation.
51-
51+
3. Click ``Install`` and follow the on-screen instructions to complete the installation.
5252
4. After installation, restart Eclipse to activate the plugin.
5353

5454

5555
.. _install_idf_eclipse_plugin_local_archive:
5656

5757
Installing IDF Eclipse Plugin from Local Archive
58-
------------------------------------------------------
58+
------------------------------------------------
5959

6060
To install the ESP-IDF Eclipse Plugin from a local archive, follow these steps:
6161

62-
1. Download the latest update site archive for the IDF Eclipse Plugin from [here](https://github.com/espressif/idf-eclipse-plugin/releases).
63-
64-
2. In Eclipse, go to `Help` > `Install New Software`.
65-
66-
3. Click the `Add…` button.
67-
68-
4. In the **Add Repository** dialog, select **Archive** and choose the file `com.espressif.idf.update-vxxxxxxx.zip`.
69-
70-
5. Click **Add**.
71-
72-
6. Select **Espressif IDF** from the list and proceed with the installation.
73-
74-
7. Restart Eclipse after the installation is complete.
75-
62+
1. Download the latest update site archive for the IDF Eclipse Plugin from `here <https://github.com/espressif/idf-eclipse-plugin/releases>`_.
63+
2. In Eclipse, go to ``Help`` > ``Install New Software``.
64+
3. Click the ``Add`` button.
65+
4. In the ``Add Repository`` dialog, select ``Archive`` and choose the file ``com.espressif.idf.update-vxxxxxxx.zip``.
66+
5. Click ``Add``.
67+
6. Select ``Espressif IDF`` from the list and continue with the installation.
68+
7. After the installation is complete, restart Eclipse.
7669

7770
.. _upgradePlugins:
7871

79-
How do I upgrade my existing IDF Eclipse Plugin?
80-
------------------------------------------------------
72+
How to Upgrade Existing IDF Eclipse Plugin
73+
------------------------------------------
74+
8175
If you are installing the IDF Eclipse Plugin for the first time, follow these steps to add the repository for the new release:
8276

83-
1. Go to `Window` > `Preferences` > `Install/Update` > `Available Software Sites`.
84-
2. Click `Add`.
85-
3. Enter the URL of the new repository: `https://dl.espressif.com/dl/idf-eclipse-plugin/updates/latest/`.
86-
4. Click `Ok`.
77+
1. Go to ``Window`` > ``Preferences`` > ``Install/Update`` > ``Available Software Sites``.
78+
2. Click ``Add``.
79+
3. Enter the `URL <https://dl.espressif.com/dl/idf-eclipse-plugin/updates/latest/>`_ of the new repository: .
80+
4. Click ``Ok``.
8781

8882
If you have already installed the IDF Eclipse Plugin using the update site URL, you can upgrade to the latest version with the following steps:
8983

90-
1. Go to `Help` > `Check for Updates`.
91-
2. If updates are found, select `Espressif IDF Plugins for Eclipse` and deselect all other items.
92-
3. Click `Next` to proceed with the installation.
84+
1. Go to ``Help`` > ``Check for Updates``.
85+
2. If updates are found, select ``Espressif IDF Plugins for Eclipse`` and deselect all other items.
86+
3. Click ``Next`` to proceed with the installation.
9387

9488
.. image:: ../../media/Update_plugins.png
95-
89+
9690

9791
.. _upgradeEspressifIdeDependencies:
98-
92+
9993
Upgrading from Espressif-IDE 3.3.0 to 3.4.0
100-
------------------------------------------------------
94+
-------------------------------------------
95+
10196
If the next version of the plugin requires updated dependencies (e.g., the minimum CDT version has changed from 11.6 to 12), make sure these dependencies are updated during installation from the update site.
10297

10398
.. image:: ../../media/Update_dependencies.png
104-
99+
105100
If the required dependencies are not updated, the installer will display the following error:
106-
`The installation cannot be completed as requested.`
101+
102+
``The installation cannot be completed as requested.``
107103

108104
To resolve this:
109105

110-
1. Click **Show original error and build my own solution**.
111-
2. Then select both:
106+
1. Click ``Show original error and build my own solution``.
107+
2. Then select both:
112108

113-
- **Update items already installed**
114-
- **Remove items already installed**
109+
- ``Update items already installed``
110+
- ``Remove items already installed``
115111

116112
.. image:: ../../media/Resolve_update_error.png
117113

118-
This will allow the installer to update or replace any conflicting components and continue the installation successfully.
119-
120-
114+
This ensures that the installer can update or replace any conflicting components, allowing the installation to complete successfully.
121115

122116
.. _troubleshooting_missing_items:
123117

124-
Troubleshooting: "Cannot complete the install because one or more required items could not be found"
125-
-----------------------------------------------------------------------------------------------------
118+
Troubleshooting
119+
---------------
126120

121+
If you encounter the error ``Cannot complete the install because one or more required items could not be found.`` during installation, it usually means that the Eclipse Platform update site is not enabled.
127122

128-
This usually happens when the Eclipse Platform update site is not enabled.
129123
To resolve this issue:
130124

131-
1. Go to ``Help`` > ``Install New Software``.
132-
2. Click **Manage**.
133-
3. Make sure the option for the **Eclipse Platform - Latest Release Update Site** is enabled.
125+
1. Go to ``Help`` > ``Install New Software``.
126+
2. Click ``Manage``.
127+
3. Make sure the option for the ``Eclipse Platform - Latest Release Update Site`` is enabled.
134128

135-
.. image:: ../../media/Resolve_update_error_2.png
129+
.. image:: ../../media/Resolve_update_error_2.png
136130

137-
4. Apply the changes and close the dialog.
138-
5. Then go to ``Help`` > ``Check for Updates`` and proceed with updating the IDE and its dependencies.
131+
4. Apply the changes and close the dialog.
132+
5. Then go to ``Help`` > ``Check for Updates`` and proceed with updating the IDE and its dependencies.
139133

140134
.. note::
141-
Enabling the Eclipse Platform update site ensures that all required dependencies can be resolved during installation or upgrade.
142135

136+
Enabling the Eclipse Platform update site ensures that all required dependencies are properly resolved during installation or upgrade.

‎docs/zh_CN/buildproject.rst‎

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,46 @@
1-
.. include:: ../en/buildproject.rst
1+
构建项目
2+
========
3+
4+
:link_to_translation:`en:[English]`
5+
6+
.. |build_icon| image:: ../../media/icons/build.png
7+
:height: 16px
8+
:align: middle
9+
10+
创建项目并配置好乐鑫目标设备及串口后，可在工具栏中点击 |build_icon| 图标来构建项目。
11+
12+
如果你是初次使用 IDE，请参照下列步骤，完成项目的构建流程：
13+
14+
1. 在 ``Project Explorer`` 中选择一个项目。
15+
2. 在第一个下拉菜单 **启动模式** 中选择 ``Run``。。
16+
3. 在第二个下拉菜单 **启动配置** 中选择你的应用程序（该程序会被自动检测）。
17+
4. 在第三个下拉菜单 **启动目标** 中选择目标芯片，如 ``esp32``。
18+
5. 点击 ``Build`` 按钮 |build_icon|，开始构建流程。
19+
20+
.. image:: ../../media/9_cmake_build.png
21+
22+
自定义构建目录
23+
--------------
24+
25+
IDE 允许为项目配置自定义构建目录：
26+
27+
1. 选择一个项目，在顶部工具栏中点击启动配置的 ``Edit`` 按钮，打开 ``Edit Configuration`` 窗口。
28+
2. 前往 ``Build Settings`` 选项卡。
29+
3. 在 ``Build folder location`` 部分填写自定义的构建目录。该自定义目录路径可以位于项目内，也可以位于文件系统中的任意位置。
30+
4. 点击 ``Ok`` 并构建项目。
31+
32+
.. note::
33+
34+
此配置指定了项目生成的所有构建产物的存放位置。
35+
36+
.. image:: ../../media/custombuilddir.png
37+
:alt: 自定义构建目录配置
38+
39+
参考文档
40+
--------
41+
42+
.. toctree::
43+
:maxdepth: 1
44+
45+
配置 CDT 构建环境变量 <additionalfeatures/configureenvvariables>
46+
添加预览或自定义 ESP-IDF 目标 <additionalfeatures/configuretoolchain>

0 commit comments

Comments
 (0)