alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'bugfix/get_started_inconsistency' into 'master'

Browse Source 
docs: Add missing target setting in step 7 of Getting Started documentation

Closes IDFGH-3863

See merge request espressif/esp-idf!10127
This commit is contained in:
Krzysztof Budzynski 2020-08-28 20:23:17 +08:00
commit f92433b946
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/en/get-started/index.rst
View File

@ -2,8 +2,6 @@
Get Started
***********
{IDF_TARGET_CL:default = "esp32", esp32 = "esp32", esp32s2 = "esp32s2"}
:link_to_translation:`zh_CN:[中文]`
This document is intended to help you set up the software development environment for the hardware based on the {IDF_TARGET_NAME} chip by Espressif.
@ -331,7 +329,7 @@ Linux and macOS
.. code-block:: bash
cd ~/esp/hello_world
idf.py set-target {IDF_TARGET_CL}
idf.py set-target {IDF_TARGET_PATH_NAME}
idf.py menuconfig
Windows
@ -340,10 +338,10 @@ Windows
.. code-block:: batch
cd %userprofile%\esp\hello_world
idf.py set-target {IDF_TARGET_CL}
idf.py set-target {IDF_TARGET_PATH_NAME}
idf.py menuconfig
Setting the target with ``idf.py set-target {IDF_TARGET}`` should be done once, after opening a new project. If the project contains some existing builds and configuration, they will be cleared and initialized. The target may be saved in environment variable to skip this step at all. See :ref:`selecting-idf-target` for additional information.
Setting the target with ``idf.py set-target {IDF_TARGET_PATH_NAME}`` should be done once, after opening a new project. If the project contains some existing builds and configuration, they will be cleared and initialized. The target may be saved in environment variable to skip this step at all. See :ref:`selecting-idf-target` for additional information.
If the previous steps have been done correctly, the following menu appears:

4
docs/zh_CN/get-started/index.rst
View File

@ -317,6 +317,7 @@ Linux 和 MacOS 操作系统
.. code-block:: bash
cd ~/esp/hello_world
idf.py set-target {IDF_TARGET_PATH_NAME}
idf.py menuconfig
Windows 操作系统
@ -325,9 +326,10 @@ Windows 操作系统
.. code-block:: batch
cd %userprofile%\esp\hello_world
idf.py set-target {IDF_TARGET_PATH_NAME}
idf.py menuconfig
打开一个新项目后，应首先设置“目标”芯片 ``idf.py set-target {IDF_TARGET}``。注意，此操作将清除并初始化项目之前的编译和配置（如有）。 您也可以直接将“目标”配置为环境变量（此时可跳过该步骤）。更多信息，请见 :ref:`selecting-idf-target`。
打开一个新项目后，应首先设置“目标”芯片 ``idf.py set-target {IDF_TARGET_PATH_NAME}``。注意，此操作将清除并初始化项目之前的编译和配置（如有）。 您也可以直接将“目标”配置为环境变量（此时可跳过该步骤）。更多信息，请见 :ref:`selecting-idf-target`。
如果之前的步骤都正确，则会显示下面的菜单：