diff --git a/docs/_static/esp-idf-installer-powershell.png b/docs/_static/esp-idf-installer-powershell.png new file mode 100644 index 0000000000..b061de9363 Binary files /dev/null and b/docs/_static/esp-idf-installer-powershell.png differ diff --git a/docs/_static/esp-idf-installer-screenshot-powershell.png b/docs/_static/esp-idf-installer-screenshot-powershell.png new file mode 100644 index 0000000000..fc61d770ec Binary files /dev/null and b/docs/_static/esp-idf-installer-screenshot-powershell.png differ diff --git a/docs/_static/esp-idf-installer-screenshot.png b/docs/_static/esp-idf-installer-screenshot.png index 80520e0109..c3e748bdb0 100644 Binary files a/docs/_static/esp-idf-installer-screenshot.png and b/docs/_static/esp-idf-installer-screenshot.png differ diff --git a/docs/en/get-started/windows-setup.rst b/docs/en/get-started/windows-setup.rst index 534a5e88f5..1dbe227696 100644 --- a/docs/en/get-started/windows-setup.rst +++ b/docs/en/get-started/windows-setup.rst @@ -32,22 +32,50 @@ For this Getting Started we're going to use the Command Prompt, but after ESP-ID ESP-IDF Tools Installer ======================= -The easiest way to install ESP-IDF's prerequisites is to download the ESP-IDF Tools installer from this URL: +The easiest way to install ESP-IDF's prerequisites is to download one of ESP-IDF Tools Installers from this URL: https://dl.espressif.com/dl/esp-idf/?idf=4.3 -https://dl.espressif.com/dl/esp-idf-tools-setup-2.4.exe +What is the usecase for Online and Offline Installer +---------------------------------------------------- -.. IMPORTANT: Next time this link is updated, please go to get-started/index.rst and rewrite the section under "Alternative File Downloads ... Windows". Then delete this comment. +Online Installer is very small and allows the installation of all available releases of ESP-IDF. The installer will download only necessary dependencies including `Git For Windows`_ during the installation process. The installer stores downloaded files in the cache directory ``%userprofile%\.espressif`` -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. +Offline Installer does not require any network connection. The installer contains all required dependencies including `Git For Windows`_ . -The installer also downloads one of the ESP-IDF release versions, or offers to use an existing one, if already present on your PC. If you don't have one, 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: +Components of the installation +------------------------------ -.. code-block:: batch +The installer deploys the following components: - mkdir %userprofile%\esp +- Embedded Python +- Cross-compilers +- OpenOCD +- CMake_ and Ninja_ build tools +- ESP-IDF +The installer also allows reusing the existing directory with ESP-IDF. The recommended directory is ``%userprofile%\Desktop\esp-idf`` where ``%userprofile%`` is your home directory. -At the end of installation, if you checkout ``Run ESP-IDF Command Prompt (cmd.exe)``, a new Windows Power Shell, i.e. the ESP-IDF Command Prompt will pop up. +Launching ESP-IDF Environment +----------------------------- + +At the end of the installation process you can check out option ``Run ESP-IDF PowerShell Environment`` or ``Run ESP-IDF Command Prompt (cmd.exe)``. The installer will launch ESP-IDF environment in selected prompt. + +``Run ESP-IDF PowerShell Environment``: + +.. figure:: ../../_static/esp-idf-installer-screenshot-powershell.png + :align: center + :alt: Completing the ESP-IDF Tools Setup Wizard with Run ESP-IDF PowerShell Environment + :figclass: align-center + + Completing the ESP-IDF Tools Setup Wizard with Run ESP-IDF PowerShell Environment + +.. figure:: ../../_static/esp-idf-installer-powershell.png + :align: center + :alt: ESP-IDF PowerShell + :figclass: align-center + + ESP-IDF PowerShell + +``Run ESP-IDF Command Prompt (cmd.exe)``: .. figure:: ../../_static/esp-idf-installer-screenshot.png :align: center diff --git a/docs/zh_CN/get-started/windows-setup.rst b/docs/zh_CN/get-started/windows-setup.rst index a83810580d..bb6cb998f5 100644 --- a/docs/zh_CN/get-started/windows-setup.rst +++ b/docs/zh_CN/get-started/windows-setup.rst @@ -23,40 +23,70 @@ ESP-IDF 需要安装一些必备工具，才能围绕 {IDF_TARGET_NAME} 构建 .. 注解:: 限定条件：Python 或 ESP-IDF 的安装路径中一定不能包含空格或括号。与此同时，除非操作系统配置为支持 Unicode UTF-8，否则 Python 或 ESP-IDF 的安装路径中也不能包括特殊字符（非 ASCII 码字符） - + 系统管理员可以通过如下方式将操作系统配置为支持 Unicode UTF-8：控制面板-更改日期、时间或数字格式-管理选项卡-更改系统地域-勾选选项 “Beta：使用 Unicode UTF-8 支持全球语言”-点击确定-重启电脑。 .. _get-started-windows-tools-installer: + ESP-IDF 工具安装器 ======================= -安装 ESP-IDF 必备工具最简易的方式是下载 ESP-IDF 工具安装器，地址如下： +安装 ESP-IDF 必备工具最简易的方式是从 https://dl.espressif.com/dl/esp-idf/?idf=4.3 中下载 ESP-IDF 工具安装器。 -https://dl.espressif.com/dl/esp-idf-tools-setup-2.4.exe +在线安装与离线安装的区别 +----------------------------------------- -.. 重要：下次更新此链接时，请重新写文件 get-started/index.rst 中“其它文件下载方式”这一章节，然后将此条注意事项删除。 +在线安装程序非常小，可以安装 ESP-IDF 的所有版本。在安装过程中，安装程序只下载必要的依赖文件，包括 `Git For Windows`_ 安装器。在线安装程序会将下载的文件存储在缓存目录 ``%userprofile%/espressif`` 中。 -本安装器可为您安装所需的交叉编译器、OpenOCD、CMake_ 和 Ninja_ 编译工具。此外，本安装器还可在有需要时下载、运行 Python_ 3.7 和 `Git For Windows`_ 的安装器。 +离线安装程序不需要任何网络连接。安装程序中包含了所有需要的依赖文件，包括 `Git For Windows`_ 安装器。 -您可以使用之前已经下载的 ESP-IDF 版本，如果没有的话，本安装器还可用于下载任意 ESP-IDF 发布版本。推荐将 ESP-IDF 下载到 ``%userprofile%\esp`` 目录下，其中 ``%userprofile%`` 代表家目录。可运行以下命令，创建 ``%userprofile%\esp``。 +安装内容 +------------ -.. code-block:: batch +安装程序会安装以下组件： - mkdir %userprofile%\esp +- 内置的 Python +- 交叉编译器 +- OpenOCD +- CMake_ 和 Ninja_ 编译工具 +- ESP-IDF -在安装结束时，如果勾选了 ``Run ESP-IDF Command Prompt (cmd.exe)``，则会弹出一个 Windows 命令提示符窗口，即 ESP-IDF 命令提示符窗口。 +安装程序允许将程序下载到现有的 ESP-IDF 目录。推荐将 ESP-IDF 下载到 ``%userprofile%\Desktop\esp-idf`` 目录下，其中 ``%userprofile%`` 代表家目录。 + +启动 ESP-IDF 环境 +------------------ + +安装结束时，如果勾选了 ``Run ESP-IDF PowerShell Environment`` 或 ``Run ESP-IDF Command Prompt (cmd.exe)``，安装程序会在选定的提示符窗口启动 ESP-IDF。 + +``Run ESP-IDF PowerShell Environment``: + +.. figure:: ../../_static/esp-idf-installer-screenshot-powershell.png + :align: center + :alt: 完成 ESP-IDF 工具安装向导时运行 Run ESP-IDF PowerShell Environment + :figclass: align-center + + 完成 ESP-IDF 工具安装向导时运行 Run ESP-IDF PowerShell Environment + +.. figure:: ../../_static/esp-idf-installer-powershell.png + :align: center + :alt: ESP-IDF PowerShell + :figclass: align-center + + ESP-IDF PowerShell + +``Run ESP-IDF Command Prompt (cmd.exe)``: .. figure:: ../../_static/esp-idf-installer-screenshot.png :align: center - :alt: 安装结束时，勾选运行 Run ESP-IDF Command Prompt (cmd.exe) + :alt: 完成 ESP-IDF 工具安装向导时运行 Run ESP-IDF Command Prompt (cmd.exe) :figclass: align-center - 安装结束时，勾选运行 Run ESP-IDF Command Prompt (cmd.exe) + 完成 ESP-IDF 工具安装向导时运行 Run ESP-IDF Command Prompt (cmd.exe) .. figure:: ../../_static/esp-idf-installer-command-prompt.png :align: center - :alt: ESP-IDF Command Prompt + :alt: ESP-IDF 命令提示符窗口 :figclass: align-center ESP-IDF 命令提示符窗口 @@ -68,14 +98,14 @@ https://dl.espressif.com/dl/esp-idf-tools-setup-2.4.exe ESP-IDF 工具安装器可在“开始”菜单中，创建一个打开 ESP-IDF 命令提示符窗口的快捷方式。本快捷方式可以打开 Windows 命令提示符（即 cmd.exe），并运行 ``export.bat`` 脚本以设置各环境变量（比如 ``PATH``，``IDF_PATH`` 等）。此外，您可还以通过 Windows 命令提示符使用各种已经安装的工具。 -注意，本快捷方式仅适用 ESP-IDF 工具安装器中指定的 ESP-IDF 路径。如果您的电脑上存在多个 ESP-IDF（比如您需要不同版本的 ESP-IDF）需要使用快捷方式，您有以下两种解决方法： +注意，本快捷方式仅适用 ESP-IDF 工具安装器中指定的 ESP-IDF 路径。如果您的电脑上存在多个 ESP-IDF 路径（比如您需要不同版本的 ESP-IDF），您有以下两种解决方法： -1. 为 ESP-IDF 工具安装器创建的快捷方式创建一个副本，并将新快捷方式的“当前路径”指定为您希望使用的 ESP-IDF 路径。 +1. 为 ESP-IDF 工具安装器创建的快捷方式创建一个副本，并将新快捷方式的 ESP-IDF 工作路径指定为您希望使用的 ESP-IDF 路径。 2. 或者，您可以运行 ``cmd.exe``，并切换至您希望使用的 ESP-IDF 目录，然后运行 ``export.bat``。注意，这种方法要求 ``PATH`` 中存在 Python 和 Git。如果您在使用时遇到有关“找不到 Python 或 Git”的错误信息，请使用第一种方法。 后续步骤 -========== +============ 当 ESP-IDF 工具安装器安装成功后，开发环境设置也到此结束。后续开发步骤，请前往 :ref:`get-started-start-project` 查看。 @@ -89,9 +119,10 @@ ESP-IDF 工具安装器可在“开始”菜单中，创建一个打开 ESP-IDF windows-setup-update + .. _MSYS2: https://www.msys2.org/ .. _CMake: https://cmake.org/download/ .. _Ninja: https://ninja-build.org/ .. _Python: https://www.python.org/downloads/windows/ .. _Git for Windows: https://gitforwindows.org/ -.. _Github Desktop: https://desktop.github.com/ \ No newline at end of file +.. _Github Desktop: https://desktop.github.com/