From 83482b89120e2a3cb9e76ba6bb646756e6c0b4c3 Mon Sep 17 00:00:00 2001 From: Krzysztof Date: Fri, 4 Sep 2020 02:05:24 +0800 Subject: [PATCH] doc: Getting Started Guide, remove shortcuts to 'build toolchain from scratch' instructions --- docs/en/get-started/linux-setup.rst | 9 ----- docs/en/get-started/macos-setup.rst | 50 ++++++++++++++++++------ docs/en/get-started/windows-setup.rst | 3 +- docs/zh_CN/get-started/linux-setup.rst | 8 ---- docs/zh_CN/get-started/macos-setup.rst | 11 ------ docs/zh_CN/get-started/windows-setup.rst | 1 - 6 files changed, 40 insertions(+), 42 deletions(-) diff --git a/docs/en/get-started/linux-setup.rst b/docs/en/get-started/linux-setup.rst index 585f31324f..2047020e4c 100644 --- a/docs/en/get-started/linux-setup.rst +++ b/docs/en/get-started/linux-setup.rst @@ -52,13 +52,4 @@ Next Steps To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf`. -Related Documents -================= - -.. toctree:: - :maxdepth: 1 - - linux-setup-scratch - - .. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository diff --git a/docs/en/get-started/macos-setup.rst b/docs/en/get-started/macos-setup.rst index caede42ece..8c49a6bd38 100644 --- a/docs/en/get-started/macos-setup.rst +++ b/docs/en/get-started/macos-setup.rst @@ -13,10 +13,6 @@ ESP-IDF will use the version of Python installed by default on macOS. sudo easy_install pip -- install pyserial:: - - pip install --user pyserial - - install CMake & Ninja build: - If you have HomeBrew_, you can run:: @@ -38,21 +34,53 @@ ESP-IDF will use the version of Python installed by default on macOS. Then you will need to install the XCode command line tools to continue. You can install these by running ``xcode-select --install``. +Installing and setting up Python 3 as default +--------------------------------------------- + +Basing on macOS `Catalina 10.15 release notes`_, use of Python 2.7 is not recommended and Python will not be included by default in future versions of macOS. Check what Python you currently have:: + + python --version + +If the output is like ``Python 2.7.17``, your default interpreter is Python 2.7. If so, also check if Python 3 isn't already installed on your computer:: + + python3 --version + +If above command returns an error, it means Python 3 is not installed. + +Below is an overview of steps to install Python 3 and making it default interpreter. + + - Installing with HomeBrew_ can be done as follows:: + + brew install python3 + ln -s /usr/local/bin/python3.8 /usr/local/bin/python + + Adjust above directory name ``/usr/local/bin/python3.8`` to point where Python 3 has been installed. To check this directory you can run ``which -a python``. + + - If you have MacPorts_, you can run:: + + sudo port install python38 + sudo port select --set python python38 + +Now open a new terminal session to verify what python is running by default:: + + python --version + +If the output is similar to ``Python 3.8.5``, your installation has been done successfully. + + +.. note:: + + This is system-wide change which may affect all of the applications. + Next Steps ========== To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf`. -Related Documents -================= - -.. toctree:: - :maxdepth: 1 - - macos-setup-scratch .. _cmake: https://cmake.org/ .. _ninja: https://ninja-build.org/ .. _ccache: https://ccache.samba.org/ .. _homebrew: https://brew.sh/ .. _MacPorts: https://www.macports.org/install.php +.. _Catalina 10.15 release notes: https://developer.apple.com/documentation/macos-release-notes/macos-catalina-10_15-release-notes diff --git a/docs/en/get-started/windows-setup.rst b/docs/en/get-started/windows-setup.rst index e62c917b84..bc4371a119 100644 --- a/docs/en/get-started/windows-setup.rst +++ b/docs/en/get-started/windows-setup.rst @@ -56,10 +56,9 @@ For advanced users who want to customize the install process: .. toctree:: :maxdepth: 1 - windows-setup-scratch windows-setup-update -.. _MSYS2: https://msys2.github.io/ +.. _MSYS2: https://www.msys2.org/ .. _cmake: https://cmake.org/download/ .. _ninja: https://ninja-build.org/ .. _Python: https://www.python.org/downloads/windows/ diff --git a/docs/zh_CN/get-started/linux-setup.rst b/docs/zh_CN/get-started/linux-setup.rst index a44d7da4b6..d0694a1aa1 100644 --- a/docs/zh_CN/get-started/linux-setup.rst +++ b/docs/zh_CN/get-started/linux-setup.rst @@ -38,14 +38,6 @@ Linux 平台工具链的标准设置 继续设置开发环境，请前往 :ref:`get-started-get-esp-idf` 章节。 -相关文档 -================= - -.. toctree:: - :maxdepth: 1 - - linux-setup-scratch - .. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository diff --git a/docs/zh_CN/get-started/macos-setup.rst b/docs/zh_CN/get-started/macos-setup.rst index 4e9322550b..8d56f99a2e 100644 --- a/docs/zh_CN/get-started/macos-setup.rst +++ b/docs/zh_CN/get-started/macos-setup.rst @@ -13,10 +13,6 @@ ESP-IDF 将使用 Mac OS 上默认安装的 Python 版本。 sudo easy_install pip -- 安装 pyserial:: - - pip install --user pyserial - - 安装 CMake 和 Ninja 编译工具： - 若有 HomeBrew_，您可以运行:: @@ -44,13 +40,6 @@ ESP-IDF 将使用 Mac OS 上默认安装的 Python 版本。 继续设置开发环境，请前往 :ref:`get-started-get-esp-idf` 章节。 -相关文档 -================= - -.. toctree:: - :maxdepth: 1 - - macos-setup-scratch .. _cmake: https://cmake.org/ .. _ninja: https://ninja-build.org/ diff --git a/docs/zh_CN/get-started/windows-setup.rst b/docs/zh_CN/get-started/windows-setup.rst index 1ea5c1022d..b4f67cd6fb 100644 --- a/docs/zh_CN/get-started/windows-setup.rst +++ b/docs/zh_CN/get-started/windows-setup.rst @@ -56,7 +56,6 @@ ESP-IDF 工具安装器可在“开始”菜单中，创建一个打开 ESP-IDF .. toctree:: :maxdepth: 1 - windows-setup-scratch windows-setup-update .. _MSYS2: https://msys2.github.io/