Skip to content

Commit a3f9a40

Browse files
Shen7436Shen7436
committed
docs: Provide CN translation for several docs
1 parent d264866 commit a3f9a40

20 files changed

+1090
-298
lines changed

‎docs/en/additionalfeatures.rst‎

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,24 @@
11
Additional IDE Features
2-
===============================
3-
.. toctree::
4-
:maxdepth: 1
2+
=======================
53

6-
LSP C/C++ Editor<additionalfeatures/lspeditor>
7-
CMake Editor<additionalfeatures/cmakeeditor>
8-
ESP-IDF Application Size Analysis<additionalfeatures/application-size-analysis>
9-
ESP-IDF Terminal<additionalfeatures/esp-terminal>
10-
Install ESP-IDF Components<additionalfeatures/install-esp-components>
11-
Heap Tracing<additionalfeatures/heaptracing>
12-
ESP-IDF OpenOCD Debugging<openocddebugging>
13-
GDB Stub Debugging<additionalfeatures/gdbstubdebugging>
14-
Core Dump Debugging<additionalfeatures/coredumpdebugging>
15-
Application Level Tracing<additionalfeatures/appleveltracing>
16-
Partition Table Editor<additionalfeatures/partitiontableeditor>
17-
NVS Partition Editor<additionalfeatures/nvspartitioneditor>
18-
Write Binary to Flash<additionalfeatures/writebinarytoflash>
19-
DFU Flashing<additionalfeatures/dfu>
20-
Wokwi Simulator<additionalfeatures/wokwisimulator>
21-
Switch Between Languages<additionalfeatures/switchlanguage>
4+
:link_to_translation:`zh_CN:[中文]`
225

6+
.. toctree::
7+
:maxdepth: 1
238

9+
LSP C/C++ Editor <additionalfeatures/lspeditor>
10+
CMake Editor <additionalfeatures/cmakeeditor>
11+
ESP-IDF Application Size Analysis <additionalfeatures/application-size-analysis>
12+
ESP-IDF Terminal <additionalfeatures/esp-terminal>
13+
Install ESP-IDF Components <additionalfeatures/install-esp-components>
14+
Heap Tracing <additionalfeatures/heaptracing>
15+
ESP-IDF OpenOCD Debugging <openocddebugging>
16+
GDB Stub Debugging <additionalfeatures/gdbstubdebugging>
17+
Core Dump Debugging <additionalfeatures/coredumpdebugging>
18+
Application Level Tracing <additionalfeatures/appleveltracing>
19+
Partition Table Editor <additionalfeatures/partitiontableeditor>
20+
NVS Partition Editor <additionalfeatures/nvspartitioneditor>
21+
Write Binary to Flash <additionalfeatures/writebinarytoflash>
22+
DFU Flashing <additionalfeatures/dfu>
23+
Wokwi Simulator <additionalfeatures/wokwisimulator>
24+
Switch Between Languages <additionalfeatures/switchlanguage>

‎docs/en/configureproject.rst‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
Configure Your Project
2-
===============================
2+
======================
33

4-
Project configuration is stored in a single file called ``sdkconfig`` located in the root directory of the project. This configuration file can be modified using the ``SDK Configuration Editor``.
4+
:link_to_translation:`zh_CN:[中文]`
5+
6+
Project configuration is stored in a single file called ``sdkconfig`` located in the root directory of the project. This configuration file can be modified using the SDK Configuration Editor.
57

68
.. note::
7-
sdkconfig file is generated only after the build. Hence, it is recommended to build the project once before configuring the project.
9+
10+
``sdkconfig`` file is generated only after the build. Hence, it is recommended to build the project once before configuring the project.
811

912
To launch the SDK Configuration Editor:
1013

‎docs/en/connectdevice.rst‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
11
Connect Your Device
2-
===============================
3-
Next, select the ESP target for your project (ignore this step if it was already set during project creation) and the serial port of your device by clicking on the gear icon. By default, the launch target dropdown will display all the supported targets provided by the plugin.
2+
===================
3+
4+
:link_to_translation:`zh_CN:[中文]`
5+
6+
Click the gear icon to select the ESP target for your project and the serial port of your device. Skip this step if these settings were configured during project creation. By default, the launch target dropdown will display all the supported targets provided by the plugin.
47

58
.. image:: ../../media/target_selection.png
69

7-
Clicking the gear icon opens the ESP Target Configuration dialog, where you can select the serial port for your device and specify the ESP board. The plugin will automatically detect serial ports connected to your machine.
10+
Clicking the gear icon opens the ``ESP Target`` configuration dialog, where you can select the serial port for your device and specify the ESP board. The plugin will automatically detect serial ports connected to your machine.
811

912
.. image:: ../../media/8_launch_target.png
1013

11-
Regarding the Serial ports and their patterns, please refer to the `ESP-IDF documentation <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-macos-setup.html#connect-your-device>`_.
14+
Regarding the serial ports and their patterns, please refer to the `ESP-IDF documentation <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-macos-setup.html#connect-your-device>`_.
1215

1316
Custom Target
14-
----------------
17+
-------------
18+
1519
If you need to add a target that is not available in the launch target dropdown, please follow the instructions below:
1620

1721
1. Click on the launch target dropdown.
1822
2. Select ``New Launch Target``.
1923
3. Select ``ESP Target``.
20-
4. Provide properties for the target where you would like to launch the application. Enter a ``Name`` for the target and select the ``Serial Port`` to which your ESP device is connected on your machine.
21-
22-
24+
4. Specify the properties of the target device where you want to launch the application. Enter a ``Name`` for the target and select the ``Serial Port`` to which your ESP device is connected on your machine.

‎docs/en/downloads.rst‎

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,39 @@
11
.. _downloads:
22

33
Espressif-IDE Downloads
4-
=========================
4+
=======================
55

6-
You can find the latest Espressif-IDE release notes from `here <https://github.com/espressif/idf-eclipse-plugin/releases>`_. Provided below are the direct download links for various platforms.
6+
:link_to_translation:`zh_CN:[中文]`
77

8-
+--------------+-------------------------------------------------------------------------------------------------------------------------------------------+
9-
| OS | Download |
10-
+==============+===========================================================================================================================================+
11-
| Windows | `Espressif-IDE-win32.win32.x86_64 <https://dl.espressif.com/dl/idf-eclipse-plugin/ide/Espressif-IDE-win32.win32.x86_64/latest>`_ |
12-
+--------------+-------------------------------------------------------------------------------------------------------------------------------------------+
13-
| macOS x86_64 | `Espressif-IDE-macosx-cocoa-x86_64 <https://dl.espressif.com/dl/idf-eclipse-plugin/ide/Espressif-IDE-macosx-cocoa-x86_64/latest>`_ |
14-
+--------------+-------------------------------------------------------------------------------------------------------------------------------------------+
15-
| macOS aarch64| `Espressif-IDE-macosx-cocoa-aarch64 <https://dl.espressif.com/dl/idf-eclipse-plugin/ide/Espressif-IDE-macosx-cocoa-aarch64/latest>`_ |
16-
+--------------+-------------------------------------------------------------------------------------------------------------------------------------------+
17-
| Linux | `Espressif-IDE-linux.gtk.x86_64 <https://dl.espressif.com/dl/idf-eclipse-plugin/ide/Espressif-IDE-linux.gtk.x86_64/latest>`_ |
18-
+--------------+-------------------------------------------------------------------------------------------------------------------------------------------+
8+
You can find the latest Espressif-IDE release notes at `here <https://github.com/espressif/idf-eclipse-plugin/releases>`_. Direct download links for various platforms are provided below.
199

10+
.. list-table::
11+
:header-rows: 1
12+
:widths: 20 80
2013

21-
macOS security notice (Applicable only for Nightly Builds)
22-
------------------------------------------------------------
23-
On macOS, if you download the archive with the browser, the strict security checks on recent macOS will prevent it to run, and complain that the program is damaged. That’s obviously not true, and the fix is simple, you need to remove the `com.apple.quarantine` extended attribute.
14+
* - OS
15+
- Download
16+
* - Windows
17+
- `Espressif-IDE-win32.win32.x86_64 <https://dl.espressif.com/dl/idf-eclipse-plugin/ide/Espressif-IDE-win32.win32.x86_64/latest>`_
18+
* - macOS x86_64
19+
- `Espressif-IDE-macosx-cocoa-x86_64 <https://dl.espressif.com/dl/idf-eclipse-plugin/ide/Espressif-IDE-macosx-cocoa-x86_64/latest>`_
20+
* - macOS aarch64
21+
- `Espressif-IDE-macosx-cocoa-aarch64 <https://dl.espressif.com/dl/idf-eclipse-plugin/ide/Espressif-IDE-macosx-cocoa-aarch64/latest>`_
22+
* - Linux
23+
- `Espressif-IDE-linux.gtk.x86_64 <https://dl.espressif.com/dl/idf-eclipse-plugin/ide/Espressif-IDE-linux.gtk.x86_64/latest>`_
24+
25+
26+
macOS Security Notice (Applicable Only for Nightly Builds)
27+
----------------------------------------------------------
28+
29+
On macOS, if you download the archive using a web browser, the strict security checks in recent macOS versions will prevent it from running and display a message that the program is damaged. This is not actually true, and the fix is simple: you just need to remove the ``com.apple.quarantine`` extended attribute.
2430

2531
.. code-block:: shell
2632
2733
$ xattr -d com.apple.quarantine ~/Downloads/Espressif-IDE-x.x.x-macosx.cocoa.x86_64.tar.gz
2834
29-
After un-archiving, if the application still complains, check/remove the attribute from the Espressif-IDE.app folder too:
35+
After unpacking the archive, if the application still shows the same warning, check and remove the attribute from the ``Espressif-IDE.app`` folder as well:
3036

3137
.. code-block:: shell
3238
33-
$ xattr -dr com.apple.quarantine ~/Downloads/Espressif-IDE.app
39+
$ xattr -dr com.apple.quarantine ~/Downloads/Espressif-IDE.app

0 commit comments

Comments
 (0)