Merge branch 'doc/win_inst_offline' into 'master'

docs: add links to Windows installer 2.5 Offline and Online versions

Closes DOC-1046

See merge request espressif/esp-idf!12242

docs/en/get-started/index.rst

@@ -255,13 +255,14 @@ The tools installer downloads a number of files attached to GitHub Releases. If
 Windows
 -------
 
-To prefer the Espressif download server when running the ESP-IDF Tools Installer or installing tools from the command line, open the System control panel, then click on Advanced Settings. Add a new Environment Variable (of type either User or System) with the name ``IDF_GITHUB_ASSETS`` and value ``dl.espressif.com/github_assets``. Click OK once done.
+To prefer the Espressif download server when running the ESP-IDF Tools Installer check out the following option in the installer window: ``Use Espressif download server instead of downloading tool packages from GitHub.``
 
-If the command line window or ESP-IDF Tools Installer window was already open before you added the new environment variable, you will need to close and reopen it.
-
-While this environment variable is still set, the ESP-IDF Tools Installer and the command line installer will prefer the Espressif download server.
+.. figure:: ../../_static/esp-idf-installer-download-server.png
+    :align: center
+    :alt: Configuring the ESP-IDF Tools Setup Wizard Espressif download server
+    :figclass: align-center
 
-.. Once the ESP-IDF Tools Installer binary is updated to include the checkbox, the above can be rewritten to refer to it
+    Configuring the ESP-IDF Tools Setup Wizard Espressif download server
 
 Linux and macOS
 ---------------

docs/en/get-started/windows-setup.rst

@@ -32,22 +32,55 @@ 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-tools-setup-2.4.exe
+- Online Installer (30 MB): https://dl.espressif.com/dl/esp-idf-tools-setup-online-2.5.exe
+- Offline Installer - includes ESP-IDF v4.2, v4.1.1 (810 MB): https://dl.espressif.com/dl/esp-idf-tools-setup-offline-2.5.exe
 
 .. 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.
 
-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.
+What is the usecase for Online and Offline Installer
+----------------------------------------------------
 
-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:
+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``
 
-.. code-block:: batch
+Offline Installer does not require any network connection. The installer contains all required dependencies including `Git For Windows`_ . The installer allows the installation of ESP-IDF with the following tags: v4.2, v4.1.1.
 
-    mkdir %userprofile%\esp
+Components of the installation
+------------------------------
 
+The installer deploys the following components:
 
-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.
+- 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.
+
+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
@@ -97,4 +130,4 @@ For advanced users who want to customize the install process:
 .. _Ninja: https://ninja-build.org/
 .. _Python: https://www.python.org/downloads/windows/
 .. _Git for Windows: https://gitforwindows.org/
-.. _Github Desktop: https://desktop.github.com/
+.. _Github Desktop: https://desktop.github.com/

docs/zh_CN/get-started/index.rst

@@ -255,13 +255,14 @@ ESP-IDF 工具安装器会下载 Github 发布版本中附带的一些工具，
 Windows 操作系统
 -----------------
 
-如果希望在运行 ESP-IDF 工具安装器或在使用命令行安装工具时优先选择 Espressif 下载服务器，可通过以下方式设置：打开系统控制面板，然后点击高级设置，添加一个新的环境变量（类型为用户或系统都可以，名称为 ``IDF_GITHUB_ASSETS``，值为 ``dl.espressif.com/github_assets``），最后点击确定。
+如果希望在运行 ESP-IDF 工具安装器时优先选择 Espressif 下载服务器，请在安装程序窗口中勾选 ``Use Espressif download server instead of downloading tool packages from GitHub.`` 选项。
 
-如果在添加新的环境变量前命令行窗口或 ESP-IDF 工具安装器窗口已经打开，请关闭这些窗口后重新打开。
-
-当设置好这个新的环境变量后，ESP-IDF 工具安装器以及命令行安装程序将会优先选择 Espressif 下载服务器。
+.. figure:: ../../_static/esp-idf-installer-download-server.png
+    :align: center
+    :alt: 配置 ESP-IDF 工具安装向导优先选择 Espressif 下载服务器
+    :figclass: align-center
 
-.. 在 ESP-IDF 工具安装器的二进制文件更新后（导入复选框），这段需要重新更新
+    配置 ESP-IDF 工具安装向导优先选择 Espressif 下载服务器
 
 Linux 和 macOS 操作系统
 --------------------------
@@ -748,4 +749,4 @@ Windows 操作系统
     :esp32: ../get-started-legacy/index
 
 .. _Stable version: https://docs.espressif.com/projects/esp-idf/zh_CN/stable/
-.. _Releases page: https://github.com/espressif/esp-idf/releases
+.. _Releases page: https://github.com/espressif/esp-idf/releases

docs/zh_CN/get-started/windows-setup.rst

@@ -28,35 +28,70 @@ ESP-IDF 需要安装一些必备工具，才能围绕 {IDF_TARGET_NAME} 构建
 
 .. _get-started-windows-tools-installer:
 
+
 ESP-IDF 工具安装器
 =======================
 
-安装 ESP-IDF 必备工具最简易的方式是下载 ESP-IDF 工具安装器，地址如下：
+安装 ESP-IDF 必备工具最简易的方式是下载 ESP-IDF 工具安装器，请选择下列地址之一：
 
-https://dl.espressif.com/dl/esp-idf-tools-setup-2.4.exe
+- 在线安装（30 MB）：https://dl.espressif.com/dl/esp-idf-tools-setup-online-2.5.exe
+- 离线安装（包括 ESP-IDF v4.2、v4.1.1，810 MB）：https://dl.espressif.com/dl/esp-idf-tools-setup-offline-2.5.exe
 
 .. 重要：下次更新此链接时，请重新写文件 get-started/index.rst 中“其它文件下载方式”这一章节，然后将此条注意事项删除。
 
-本安装器可为您安装所需的交叉编译器、OpenOCD、CMake_ 和 Ninja_ 编译工具。此外，本安装器还可在有需要时下载、运行 Python_ 3.7 和 `Git For Windows`_ 的安装器。
+在线安装与离线安装的区别
+-----------------------------------------
+
+在线安装程序非常小，可以安装 ESP-IDF 的所有版本。在安装过程中，安装程序只下载必要的依赖文件，包括 `Git For Windows`_ 安装器。在线安装程序会将下载的文件存储在缓存目录 ``%userprofile%/espressif`` 中。
+
+离线安装程序不需要任何网络连接。安装程序中包含了所有需要的依赖文件，包括 `Git For Windows`_ 安装器。该安装程序可以安装 v4.2 和 v4.1.1 版本的 ESP-IDF。
+
+安装内容
+------------
+
+安装程序会安装以下组件：
 
-您可以使用之前已经下载的 ESP-IDF 版本，如果没有的话，本安装器还可用于下载任意 ESP-IDF 发布版本。推荐将 ESP-IDF 下载到 ``%userprofile%\esp`` 目录下，其中 ``%userprofile%`` 代表家目录。可运行以下命令，创建 ``%userprofile%\esp``。
+- 内置的 Python
+- 交叉编译器
+- OpenOCD
+- CMake_ 和 Ninja_ 编译工具
+- ESP-IDF
 
-.. code-block:: batch
+安装程序允许将程序下载到现有的 ESP-IDF 目录。推荐将 ESP-IDF 下载到 ``%userprofile%\Desktop\esp-idf`` 目录下，其中 ``%userprofile%`` 代表家目录。
 
-    mkdir %userprofile%\esp
+启动 ESP-IDF 环境
+------------------
 
-在安装结束时，如果勾选了 ``Run ESP-IDF Command Prompt (cmd.exe)``，则会弹出一个 Windows 命令提示符窗口，即 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 +103,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,6 +124,7 @@ ESP-IDF 工具安装器可在“开始”菜单中，创建一个打开 ESP-IDF
 
     windows-setup-update
 
+
 .. _MSYS2: https://www.msys2.org/
 .. _CMake: https://cmake.org/download/
 .. _Ninja: https://ninja-build.org/