docs: add a command to create an esp directory before cloning esp-idf

This commit is contained in:
Wang Fang 2020-08-11 14:08:45 +08:00 committed by bot
parent 0fa3ff8bf0
commit a5e5794059
5 changed files with 21 additions and 10 deletions

View File

@ -145,6 +145,10 @@ Some tools need to be installed on the computer before proceeding to the next st
.. _Linux: ../get-started/linux-setup.html
.. _Mac OS: ../get-started/macos-setup.html
.. note::
This guide uses the directory ``~/esp`` on Linux and macOS or ``%userprofile%\esp`` on Windows as an installation folder for ESP-IDF. You can use any directory, but you will need to adjust paths for the commands respectively. Keep in mind that ESP-IDF does not support spaces in paths.
.. _get-started-get-esp-idf:
Step 2. Get ESP-IDF
@ -154,10 +158,6 @@ To build applications for the {IDF_TARGET_NAME}, you need the software libraries
To get ESP-IDF, navigate to your installation directory and clone the repository with ``git clone``, following instructions below specific to your operating system.
.. note::
This guide uses the directory ``~/esp`` on Linux and macOS or ``%userprofile%\esp`` on Windows as an installation folder for ESP-IDF. You can use any directory, but you will need to adjust paths for the commands respectively. Keep in mind that ESP-IDF does not support spaces in paths.
Linux and macOS
~~~~~~~~~~~~~~~

View File

@ -32,7 +32,12 @@ https://dl.espressif.com/dl/esp-idf-tools-setup-2.3.exe
The installer includes the cross-compilers, OpenOCD, cmake_ and Ninja_ build tool. The installer can also download and run installers for Python_ 3.7 and `Git For Windows`_ if they are not already installed on the computer.
The installer also offers to download one of the ESP-IDF release versions.
The installer also offers to download one of the ESP-IDF release versions. Please choose a directory for downloading ESP-IDF. The recommended directory is ``%userprofile%\esp`` where ``%userprofile%`` is your home directory. If you do not have it yet, please run the following command to create a new one:
.. code-block:: batch
mkdir %userprofile%\esp
Using the Command Prompt
========================

View File

@ -17,6 +17,7 @@ TEMPLATES = {
"git-clone-bash": """
.. code-block:: bash
mkdir -p ~/esp
cd ~/esp
git clone %(clone_args)s--recursive https://github.com/espressif/esp-idf.git
""",
@ -70,6 +71,7 @@ TEMPLATES = {
"git-clone-bash": """
.. code-block:: bash
mkdir -p ~/esp
cd ~/esp
git clone %(clone_args)s--recursive https://github.com/espressif/esp-idf.git
""",

View File

@ -141,6 +141,10 @@
.. _Linux: ../get-started/linux-setup.html
.. _Mac OS: ../get-started/macos-setup.html
.. note::
在本文档中Linux 和 MacOS 操作系统中 ESP-IDF 的默认安装路径为 ``~/esp``Windows 操作系统的默认路径为 ``%userprofile%\esp``。您也可以将 ESP-IDF 安装在任何其他路径下但请注意在使用命令行时进行相应替换。注意ESP-IDF 不支持带有空格的路径。
.. _get-started-get-esp-idf:
@ -151,10 +155,6 @@
获取 ESP-IDF 的本地副本:打开终端,切换到您要保存 ESP-IDF 的工作目录,使用 ``git clone`` 命令克隆远程仓库。针对不同操作系统的详细步骤,请见下文。
.. note::
在本文档中Linux 和 MacOS 操作系统中 ESP-IDF 的默认安装路径为 ``~/esp``Windows 操作系统的默认路径为 ``%userprofile%\esp``。您也可以将 ESP-IDF 安装在任何其他路径下但请注意在使用命令行时进行相应替换。注意ESP-IDF 不支持带有空格的路径。
Linux 和 MacOS 操作系统
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@ -32,7 +32,11 @@ https://dl.espressif.com/dl/esp-idf-tools-setup-2.3.exe
本安装器可为您安装所需的交叉编译器、OpenOCD、cmake_ 和 Ninja_ 编译工具,以及一款 mconf-idf_ 配置工具。此外,本安装器还可在有需要时下载、运行 Python_ 3.7 和 `Git For Windows` 的安装器。
本安装器还可用于下载任意 ESP-IDF 发布版本。
本安装器还可用于下载任意 ESP-IDF 发布版本。推荐将 ESP-IDF 下载到 ``%userprofile%\esp`` 目录下,其中 ``%userprofile%`` 代表家目录。可运行以下命令,创建 ``%userprofile%\esp``
.. code-block:: batch
mkdir %userprofile%\esp
使用命令提示符
========================