alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
b85f877817
esp-idf/docs/en/get-started/windows-setup-scratch.rst

119 lines
4.8 KiB
ReStructuredText
Raw Normal View History

docs: Make CMake build system default, mark GNU Make as legacy option All `-cmake` suffixes are removed Where a GNU Make option is renamed, the `-legacy` suffix is used
2019-06-24 21:26:53 -04:00
********************************************
Setup Windows Toolchain from Scratch
********************************************
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
:link_to_translation:`zh_CN:[中文]`
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
This is a step-by-step alternative to running the :doc:`ESP-IDF Tools Installer <windows-setup>` for the CMake-based build system. Installing all of the tools by hand allows more control over the process, and also provides the information for advanced users to customize the install.
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
To quickly setup the toolchain and other tools in standard way, using the ESP-IDF Tools installer, proceed to section :doc:`windows-setup`.
Getting started guides
2017-03-26 18:01:52 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
.. note::
The GNU Make based build system requires the MSYS2_ Unix compatibility environment on Windows. The CMake-based build system does not require this environment.
docs: Make CMake build system default, mark GNU Make as legacy option All `-cmake` suffixes are removed Where a GNU Make option is renamed, the `-legacy` suffix is used
2019-06-24 21:26:53 -04:00
.. _get-esp-idf-windows-command-line:
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
Get ESP-IDF
===========
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
.. note::
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
Previous versions of ESP-IDF used the **MSYS2 bash terminal** command line. The current cmake-based build system can run in the regular **Windows Command Prompt** which is used here.
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
If you use a bash-based terminal or PowerShell, please note that some command syntax will be different to what is shown below.
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
Open Command Prompt and run the following commands:
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
.. include:: /_build/inc/git-clone-windows.inc
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
ESP-IDF will be downloaded into ``%userprofile%\esp\esp-idf``.
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
Consult :doc:`/versions` for information about which ESP-IDF version to use in a given situation.
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
.. include:: /_build/inc/git-clone-notes.inc
doc: Add steps to update Windows environment installations
2017-09-20 21:15:09 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
.. note::
doc: Add steps to update Windows environment installations
2017-09-20 21:15:09 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
Do not miss the ``--recursive`` option. If you have already cloned ESP-IDF without this option, run another command to get all the submodules::
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
cd esp-idf
git submodule update --init
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
Tools
=====
doc: Add steps to update Windows environment installations
2017-09-20 21:15:09 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
cmake
^^^^^
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
Download the latest stable release of CMake_ for Windows and run the installer.
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
When the installer asks for Install Options, choose either "Add CMake to the system PATH for all users" or "Add CMake to the system PATH for the current user".
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
Ninja build
^^^^^^^^^^^
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
.. note::
Ninja currently only provides binaries for 64-bit Windows. It is possible to use CMake and ``idf.py`` with other build tools, such as mingw-make, on 32-bit windows. However this is currently undocumented.
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
Fix broken links in 'Getting Started' gudes
2019-08-02 05:09:33 -04:00
Download the ninja_ latest stable Windows release from the (`download page <ninja-dl_>`_).
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
Fix broken links in 'Getting Started' gudes
2019-08-02 05:09:33 -04:00
The Ninja for Windows download is a .zip file containing a single ``ninja.exe`` file which needs to be unzipped to a directory which is then :ref:`added to your Path <add-directory-windows-path>` (or you can choose a directory which is already on your Path).
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
Docs: Encourage to used Python 3
2020-02-20 10:00:53 -05:00
Python
^^^^^^
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
Docs: Encourage to used Python 3
2020-02-20 10:00:53 -05:00
Download the latest Python_ for Windows installer, and run it.
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
The "Customise" step of the Python installer gives a list of options. The last option is "Add python.exe to Path". Change this option to select "Will be installed".
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
Once Python is installed, open a Windows Command Prompt from the Start menu and run the following command::
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
pip install --user pyserial
windows config: Update Windows setup script, pre-installed image, instructions. Add notes about MSYS2 package mirrors & HTTP proxies for users in China. Closes #260 https://github.com/espressif/esp-idf/issues/260 Closes #281 https://github.com/espressif/esp-idf/issues/281 Closes #200 https://github.com/espressif/esp-idf/issues/200 Closes #430 https://github.com/espressif/esp-idf/pull/430 Accomplishes similar goals to #264 https://github.com/espressif/esp-idf/pull/264
2017-03-20 23:17:19 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
Toolchain Setup
===============
Getting started guides
2017-03-26 18:01:52 -04:00
docs: generate toolchain download links
2018-08-29 09:30:03 -04:00
.. include:: /_build/inc/download-links.inc
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
Download the precompiled Windows toolchain:
Getting started guides
2017-03-26 18:01:52 -04:00
docs: generate toolchain download links
2018-08-29 09:30:03 -04:00
|download_link_win32|
Getting started guides
2017-03-26 18:01:52 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
Unzip the zip file to ``C:\Program Files`` (or some other location). The zip file contains a single directory ``xtensa-esp32-elf``.
Getting started guides
2017-03-26 18:01:52 -04:00
Fix broken links in 'Getting Started' gudes
2019-08-02 05:09:33 -04:00
Next, the ``bin`` subdirectory of this directory must be :ref:`added to your Path <add-directory-windows-path>`. For example, the directory to add may be ``C:\Program Files\xtensa-esp32-elf\bin``.
Getting started guides
2017-03-26 18:01:52 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
.. note::
If you already have the MSYS2 environment (for use with the "GNU Make" build system) installed, you can skip the separate download and add the directory ``C:\msys32\opt\xtensa-esp32-elf\bin`` to the Path instead, as the toolchain is included in the MSYS2 environment.
Getting started guides
2017-03-26 18:01:52 -04:00
docs: Make CMake build system default, mark GNU Make as legacy option All `-cmake` suffixes are removed Where a GNU Make option is renamed, the `-legacy` suffix is used
2019-06-24 21:26:53 -04:00
.. _add-directory-windows-path:
doc: Add steps to update Windows environment installations
2017-09-20 21:15:09 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
Adding Directory to Path
doc: Add steps to update Windows environment installations
2017-09-20 21:15:09 -04:00
========================
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
To add any new directory to your Windows Path environment variable:
doc: Add steps to update Windows environment installations
2017-09-20 21:15:09 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
Open the System control panel and navigate to the Environment Variables dialog. (On Windows 10, this is found under Advanced System Settings).
doc: Add steps to update Windows environment installations
2017-09-20 21:15:09 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
Double-click the ``Path`` variable (either User or System Path, depending if you want other users to have this directory on their path.) Go to the end of the value, and append ``;<new value>``.
doc: Add steps to update Windows environment installations
2017-09-20 21:15:09 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
Next Steps
==========
Getting started guides
2017-03-26 18:01:52 -04:00
docs: Make CMake build system default, mark GNU Make as legacy option All `-cmake` suffixes are removed Where a GNU Make option is renamed, the `-legacy` suffix is used
2019-06-24 21:26:53 -04:00
To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf`.
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
More link corrections
2019-08-02 05:58:08 -04:00
.. _CMake: https://cmake.org/download/
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
.. _ninja: https://ninja-build.org/
Fix broken links in 'Getting Started' gudes
2019-08-02 05:09:33 -04:00
.. _ninja-dl: https://github.com/ninja-build/ninja/releases
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
.. _Python: https://www.python.org/downloads/windows/
doc: Fix some Windows Setup Guide links
2017-03-29 20:29:03 -04:00
.. _MSYS2: https://msys2.github.io/
More link corrections
2019-08-02 05:58:08 -04:00
.. _kconfig-frontends releases page: https://github.com/espressif/kconfig-frontends/releases
doc: Fix broken Release page links when building a stable version
2020-05-19 20:50:44 -04:00
.. Note: These two targets may be used from git-clone-notes.inc depending on version, don't remove
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
.. _Stable version: https://docs.espressif.com/projects/esp-idf/en/stable/
doc: Fix broken Release page links when building a stable version
2020-05-19 20:50:44 -04:00
.. _Releases page: https://github.com/espressif/esp-idf/releases
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-24 21:29:49 -04:00
Reference in New Issue Copy Permalink