Skip to content

Commit

Permalink
Merge pull request #1392 from espressif/docs/translate_prerequisites
Browse files Browse the repository at this point in the history
docs: Provide CN translation for prerequisites.rst
  • Loading branch information
Shen765 authored Jan 7, 2025
2 parents d2ae042 + 3b0afc2 commit b31fbd6
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 17 deletions.
4 changes: 2 additions & 2 deletions docs_espressif/en/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ The ESP-IDF extension for VSCode Code empowers developers to efficiently develop
:maxdepth: 1

Prerequisites <prerequisites>
Installation <installation>
Install ESP-IDF and Tools <installation>
Start a Project <startproject>
Connect Your Device <connectdevice>
Configure Your Project <configureproject>
Build the Project <buildproject>
Build Your Project <buildproject>
Flash onto the Device <flashdevice>
Monitor the Output <monitoroutput>
Debug Your Project <debugproject>
Expand Down
28 changes: 17 additions & 11 deletions docs_espressif/en/prerequisites.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
Prerequisites
===============================
The minimum requirements for running the ESP-IDF Extension with the VSCode are below.
=============

- `Visual Studio Code <https://code.visualstudio.com/>`_.
:link_to_translation:`zh_CN:[中文]`

You need to install some software packages and tools based on your operating system.

Windows
-------------------------------
-------

- `Visual Studio Code <https://code.visualstudio.com/>`_

.. note::

No additional prerequisites required, the installation step will take care of the rest.
No additional prerequisites are required. The :ref:`installation <installation>` step will handle the rest.

MacOS/Linux
-------------------------------
macOS/Linux
-----------

- `Python 3.12 <https://www.python.org/downloads/>`_ and above.
- `Git <https://git-scm.com/downloads>`_.
- Install the following `ESP-IDF Prerequisites <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-macos-setup.html#step-1-install-prerequisites>`_.
- `Visual Studio Code <https://code.visualstudio.com/>`_
- `Python 3.12 <https://www.python.org/downloads/>`_ and above
- `Git <https://git-scm.com/downloads>`_
- `ESP-IDF Prerequisites <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-macos-setup.html#step-1-install-prerequisites>`_

Next proceed to :ref:`Install ESP-IDF and Tools <installation>`.
Next, proceed to :ref:`Install ESP-IDF and Tools <installation>`.
6 changes: 3 additions & 3 deletions docs_espressif/zh_CN/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
.. toctree::
:maxdepth: 1

安装包 <prerequisites>
安装 <installation>
准备工作 <prerequisites>
安装 ESP-IDF 和工具 <installation>
启动项目 <startproject>
连接设备 <connectdevice>
配置项目 <configureproject>
Expand All @@ -21,7 +21,7 @@
故障排除 <troubleshooting>
设置 <settings>
可用命令列表 <commands>
FAQs <faqs>
常见问题 <faqs>

功能
----
Expand Down
26 changes: 25 additions & 1 deletion docs_espressif/zh_CN/prerequisites.rst
Original file line number Diff line number Diff line change
@@ -1 +1,25 @@
.. include:: ../en/prerequisites.rst
准备工作
========

:link_to_translation:`en:[English]`

请根据操作系统,安装相应的软件包和工具。

Windows
-------

- `Visual Studio Code <https://code.visualstudio.com/>`_。

.. note::

无需额外的准备,:ref:`安装 <installation>` 步骤将准备好一切所需工具。

macOS/Linux
-----------

- `Visual Studio Code <https://code.visualstudio.com/>`_
- `Python 3.12 <https://www.python.org/downloads/>`_ 及以上版本
- `Git <https://git-scm.com/downloads>`_
- `ESP-IDF 安装准备 <https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/get-started/linux-macos-setup.html#get-started-prerequisites>`_

接下来,请参考 :ref:`安装 ESP-IDF 和工具 <installation>`。

0 comments on commit b31fbd6

Please sign in to comment.