diff --git a/docs/zh_CN/get-started/eclipse-setup.rst b/docs/zh_CN/get-started/eclipse-setup.rst index 445c04b02d..cb79147b4d 100644 --- a/docs/zh_CN/get-started/eclipse-setup.rst +++ b/docs/zh_CN/get-started/eclipse-setup.rst @@ -14,4 +14,4 @@ ESP-IDF V4.0 默认采用基于 CMake 的构建系统。 .. only:: esp32 - 如需使用针对 GNU Make 传统构建系统的 Eclipse IDE 开发环境，请前往 :doc:`快速入门（传统 GNU Make `，查看 :doc:`Eclipse IDE 的创建和烧录指南（传统 GNU Make）`。 + 如需使用针对 GNU Make 传统构建系统的 Eclipse IDE 开发环境，请前往 :doc:`快速入门（传统 GNU Make）`，查看 :doc:`Eclipse IDE 的创建和烧录指南（传统 GNU Make）`。 \ No newline at end of file diff --git a/docs/zh_CN/get-started/linux-setup.rst b/docs/zh_CN/get-started/linux-setup.rst index 089487cee4..3008149815 100644 --- a/docs/zh_CN/get-started/linux-setup.rst +++ b/docs/zh_CN/get-started/linux-setup.rst @@ -19,10 +19,10 @@ Linux 平台工具链的标准设置 - Arch:: - sudo pacman -S --needed gcc git make flex bison gperf python-pip python-pyserial cmake ninja ccache dfu-util + sudo pacman -S --needed gcc git make flex bison gperf python-pip cmake ninja ccache dfu-util -.. note:: - 使用 ESP-IDF 需要 CMake 3.5 或以上版本。较早版本的 Linux 可能需要升级才能向后移植仓库，或安装 "cmake3" 软件包，而不是安装 "cmake"。 +.. 注解:: + 使用 ESP-IDF 需要 CMake 3.5 或以上版本。较早的 Linux 发行版可能需要升级自身的软件源仓库，或开启 backports 套件库，或安装 "cmake3" 软件包（不是安装 "cmake"）。 其他提示 =============== @@ -30,7 +30,7 @@ Linux 平台工具链的标准设置 权限问题 /dev/ttyUSB0 ------------------------------------------------------------ -使用某些 Linux 版本向 {IDF_TARGET_NAME} 烧写固件时，可能会出现 ``Failed to open port /dev/ttyUSB0`` 错误消息。此时，可以将当前用户增加至 :ref:` Linux Dialout 组 `。 +使用某些 Linux 版本向 {IDF_TARGET_NAME} 烧录固件时，可能会出现 ``Failed to open port /dev/ttyUSB0`` 错误消息。此时可以将用户添加至 :ref:`Linux Dialout 组`。 设置 Python 3 为 Ubuntu 和 Debian 默认 Python 版本 ---------------------------------------------------- @@ -43,7 +43,7 @@ Ubuntu v20.04 和 Debian v7 之前的版本默认解释器为 Python 2.7，但 sudo update-alternatives --install /usr/bin/python python /usr/bin/python3 10 -.. note:: +.. 注解:: 上述设置为全局设置，同时会影响到其它应用。 后续步骤 @@ -52,5 +52,4 @@ Ubuntu v20.04 和 Debian v7 之前的版本默认解释器为 Python 2.7，但 继续设置开发环境，请前往 :ref:`get-started-get-esp-idf` 章节。 -.. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository - +.. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository \ No newline at end of file diff --git a/docs/zh_CN/get-started/macos-setup.rst b/docs/zh_CN/get-started/macos-setup.rst index 77a7c87a23..16f92fb1d3 100644 --- a/docs/zh_CN/get-started/macos-setup.rst +++ b/docs/zh_CN/get-started/macos-setup.rst @@ -1,5 +1,5 @@ ********************************************** -MacOS 平台工具链的标准设置 +macOS 平台工具链的标准设置 ********************************************** :link_to_translation:`en:[English]` @@ -7,7 +7,7 @@ MacOS 平台工具链的标准设置 安装准备 ===================== -ESP-IDF 将使用 Mac OS 上默认安装的 Python 版本。 +ESP-IDF 将使用 macOS 上默认安装的 Python 版本。 - 安装 pip:: @@ -23,7 +23,7 @@ ESP-IDF 将使用 Mac OS 上默认安装的 Python 版本。 sudo port install cmake ninja dfu-util - - 若以上均不适用，请访问 CMake_ 和 Ninja_ 主页，查询有关 Mac OS 平台的下载安装问题。 + - 若以上均不适用，请访问 CMake_ 和 Ninja_ 主页，查询有关 macOS 平台的下载安装问题。 - 强烈建议同时安装 ccache_ 以获得更快的编译速度。如有 HomeBrew_，可通过 MacPorts_ 上的 ``brew install ccache`` 或 ``sudo port install ccache`` 完成安装。 @@ -35,10 +35,48 @@ ESP-IDF 将使用 Mac OS 上默认安装的 Python 版本。 则必须安装 XCode 命令行工具，具体可运行 ``xcode-select --install``。 +安装并设置 Python 3 为默认版本 +--------------------------------------------- + +`Catalina 10.15 发布说明`_ 中表示不推荐使用 Python 2.7 版本，在未来的 macOS 版本中也不会默认包含 Python。执行以下命令来检查您当前使用的 Python 版本:: + + python --version + +如果输出结果是 ``Python 2.7.17``，则代表您的默认解析器是 Python 2.7。这时需要您运行以下命令检查电脑上是否已经安装过 Python 3:: + + python3 --version + +如果运行上述命令出现错误，则代表电脑上没有安装 Python 3。 + +请根据以下步骤安装 Python 3 并使其成为默认解释器： + + - 使用 HomeBrew_ 进行安装的方法如下:: + + brew install python3 + ln -s /usr/local/bin/python3.8 /usr/local/bin/python + + 将上述的目录名 ``/usr/local/bin/python3.8`` 修改为 Python 3 所在的目录。您可以运行 ``which -a python`` 来查看 Python 3 所在的目录。 + + - 使用 MacPorts_ 进行安装的方法如下:: + + sudo port install python38 + sudo port select --set python python38 + +现在您可以打开终端窗口验证默认运行的 Python 版本:: + + python --version + +如果输出结果类似于 ``Python 3.8.5`` 则代表安装成功。 + +.. 注解:: + + 上述设置为全局设置，同时会影响到其它应用。 + + 后续步骤 ========== -继续设置开发环境，请前往 :ref:`get-started-get-esp-idf` 章节。 +请前往 :ref:`get-started-get-esp-idf` 章节继续设置开发环境。 .. _cmake: https://cmake.org/ @@ -46,4 +84,4 @@ ESP-IDF 将使用 Mac OS 上默认安装的 Python 版本。 .. _ccache: https://ccache.samba.org/ .. _homebrew: https://brew.sh/ .. _MacPorts: https://www.macports.org/install.php - +.. _Catalina 10.15 发布说明: https://developer.apple.com/documentation/macos-release-notes/macos-catalina-10_15-release-notes \ No newline at end of file diff --git a/docs/zh_CN/get-started/windows-setup.rst b/docs/zh_CN/get-started/windows-setup.rst index 9f6e518bc7..a88459498c 100644 --- a/docs/zh_CN/get-started/windows-setup.rst +++ b/docs/zh_CN/get-started/windows-setup.rst @@ -6,31 +6,38 @@ Windows 平台工具链的标准设置 .. only:: esp32 - .. note:: + .. 注解:: 目前，基于 CMake 的构建系统仅支持 64 位 Windows 版本。32 位 Windows 版本的用户可根据 :doc:`传统 GNU Make 构建系统<../get-started-legacy/windows-setup>` 中的介绍进行操作。 概述 ============ -ESP-IDF 需要安装一些必备工具，才能围绕 {IDF_TARGET_NAME} 构建固件，包括 Python、Git、交叉编译器、menuconfig 工具、CMake和 Ninja 编译工具等。 +ESP-IDF 需要安装一些必备工具，才能围绕 {IDF_TARGET_NAME} 构建固件，包括 Python、Git、交叉编译器、CMake 和 Ninja 编译工具等。 在本入门指南中，我们通过 **命令提示符** 进行有关操作。不过，您在安装 ESP-IDF 后还可以使用 :doc:`Eclipse ` 或其他支持 CMake 的图形化工具 IDE。 .. only:: esp32 - .. note:: - 较早 ESP-IDF 版本使用 :doc:`传统 GNU Make 编译系统<../get-started-legacy/windows-setup>` 和 MSYS2_ Unix 兼容环境。但如今已非必需，用户可直接通过 Windows 命令提示符使用 ESP-IDF。 + .. 注解:: + 较早 ESP-IDF 版本使用 :doc:`传统 GNU Make 构建系统<../get-started-legacy/windows-setup>` 和 MSYS2_ Unix 兼容环境。但如今已非必需，用户可直接通过 Windows 命令提示符使用 ESP-IDF。 + +.. 注解:: + 限定条件：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 必备工具最简易的方式是下载 ESP-IDF 工具安装器，地址如下： https://dl.espressif.com/dl/esp-idf-tools-setup-2.3.exe -本安装器可为您安装所需的交叉编译器、OpenOCD、cmake_ 和 Ninja_ 编译工具，以及一款 mconf-idf_ 配置工具。此外，本安装器还可在有需要时下载、运行 Python_ 3.7 和 `Git For Windows` 的安装器。 +.. 重要：下次更新此链接时，请重新写文件 get-started/index.rst 中“其它文件下载方式”这一章节，然后将此条注意事项删除。 + +本安装器可为您安装所需的交叉编译器、OpenOCD、CMake_ 和 Ninja_ 编译工具。此外，本安装器还可在有需要时下载、运行 Python_ 3.7 和 `Git For Windows`_ 的安装器。 本安装器还可用于下载任意 ESP-IDF 发布版本。推荐将 ESP-IDF 下载到 ``%userprofile%\esp`` 目录下，其中 ``%userprofile%`` 代表家目录。可运行以下命令，创建 ``%userprofile%\esp``。 @@ -45,16 +52,16 @@ https://dl.espressif.com/dl/esp-idf-tools-setup-2.3.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 路径。 -2. 运行 ``cmd.exe``，并更新至您希望使用的 ESP-IDF 目录，然后运行 ``export.bat``。注意，这种方法要求 ``PATH`` 中存在 Python 和 Git。如果您在使用时遇到有关“找不到 Python 或 Git” 的错误信息，请使用第一种方法。 +2. 或者，您可以运行 ``cmd.exe``，并切换至您希望使用的 ESP-IDF 目录，然后运行 ``export.bat``。注意，这种方法要求 ``PATH`` 中存在 Python 和 Git。如果您在使用时遇到有关“找不到 Python 或 Git”的错误信息，请使用第一种方法。 后续步骤 ========== -当 ESP-IDF 工具安装器安装完成后，则开发环境设置也到此结束。后续开发步骤，请前往 :ref:`get-started-start-project` 查看。 +当 ESP-IDF 工具安装器安装成功后，开发环境设置也到此结束。后续开发步骤，请前往 :ref:`get-started-start-project` 查看。 相关文档 ================= @@ -67,10 +74,8 @@ ESP-IDF 工具安装器可在“开始”菜单中，创建一个打开 ESP-IDF windows-setup-update .. _MSYS2: https://www.msys2.org/ -.. _cmake: https://cmake.org/download/ -.. _ninja: https://ninja-build.org/ +.. _CMake: https://cmake.org/download/ +.. _Ninja: https://ninja-build.org/ .. _Python: https://www.python.org/downloads/windows/ .. _Git for Windows: https://gitforwindows.org/ -.. _mconf-idf: https://github.com/espressif/kconfig-frontends/releases/ -.. _Github Desktop: https://desktop.github.com/ - +.. _Github Desktop: https://desktop.github.com/ \ No newline at end of file