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
f50a8cc7b5
esp-idf/docs/en/get-started/windows-setup.rst

101 lines
5.0 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
***********************************************
Standard Setup of Toolchain for Windows
***********************************************
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
doc(global): build cross-language links for translated documents
2018-04-27 02:46:13 -04:00
:link_to_translation:`zh_CN:[中文]`
Getting started guides
2017-03-26 18:01:52 -04:00
docs: Add "explicit only" directive & use only:: to block out some chip-specific parts of docs
2019-11-22 00:57:09 -05:00
.. only:: esp32
.. note::
Currently only 64-bit versions of Windows are supported. 32-bit Windows can use the :doc:`Legacy GNU Make Build System<../get-started-legacy/windows-setup>`.
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
Getting started guides
2017-03-26 18:01:52 -04:00
Introduction
============
Doc: Remove menuconfig tool which is not used anymore
2019-11-19 09:33:10 -05:00
ESP-IDF requires some prerequisite tools to be installed so you can build firmware for supported chips. The prerequisite tools include Python, Git, cross-compilers, CMake and Ninja build tools.
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
For this Getting Started we're going to use the Command Prompt, but after ESP-IDF is installed you can use :doc:`Eclipse <eclipse-setup>` or another graphical IDE with CMake support instead.
Getting started guides
2017-03-26 18:01:52 -04:00
docs: Add 'toctree filter' directive & filter out ESP32-only pages from S2 docs
2019-11-22 00:58:04 -05:00
.. only:: esp32
docs: Mark some more docs sections as ESP32 only
2019-11-26 01:22:50 -05:00
docs: Add 'toctree filter' directive & filter out ESP32-only pages from S2 docs
2019-11-22 00:58:04 -05:00
.. note::
Previous versions of ESP-IDF used the :doc:`Legacy GNU Make Build System<../get-started-legacy/windows-setup>` and MSYS2_ Unix compatibility environment. This is no longer required, ESP-IDF can be used from the Windows Command Prompt.
Getting started guides
2017-03-26 18:01:52 -04:00
docs: add ESP-IDF Windows Installation limitations.
2020-11-24 08:09:38 -05:00
.. note::
Limitation: the installation path of Python or ESP-IDF must not contain white spaces or parentheses.
Limitation: the installation path of Python or ESP-IDF should not contain special characters (non-ASCII) unless the operating system is configured with "Unicode UTF-8" support.
System Administrator can enable the support via Control Panel - Change date, time, or number formats - Administrative tab - Change system locale - check the option "Beta: Use Unicode UTF-8 for worldwide language support" - Ok and reboot the computer.
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-started-windows-tools-installer:
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
ESP-IDF Tools Installer
=======================
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
The easiest way to install ESP-IDF's prerequisites is to download the ESP-IDF Tools installer from this URL:
Getting started guides
2017-03-26 18:01:52 -04:00
tools: support for embedded python
2020-12-16 11:40:13 -05:00
https://dl.espressif.com/dl/esp-idf-tools-setup-2.4.exe
Getting started guides
2017-03-26 18:01:52 -04:00
tools: Use GitHub download URLs for all files that can be downloaded from GitHub
2020-09-25 05:19:17 -04:00
.. 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.
docs: add ESP-IDF Windows Installation limitations.
2020-11-24 08:09:38 -05:00
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.
Getting started guides
2017-03-26 18:01:52 -04:00
docs: update the documents based on customer feedbacks
2020-12-24 22:46:41 -05:00
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:
docs: add a command to create an esp directory before cloning esp-idf
2020-08-11 02:08:45 -04:00
.. code-block:: batch
mkdir %userprofile%\esp
Updated get started instructions for windows following https://esp32.com/viewtopic.php?f=13&t=4232
2018-01-24 14:41:35 -05:00
docs: Update FreeRTOS version, add tips to set up instructions for Windows
2021-01-22 02:51:15 -05:00
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.
.. figure:: ../../_static/esp-idf-installer-screenshot.png
:align: center
:alt: Completing the ESP-IDF Tools Setup Wizard with Run ESP-IDF Command Prompt (cmd.exe)
:figclass: align-center
Completing the ESP-IDF Tools Setup Wizard with Run ESP-IDF Command Prompt (cmd.exe)
.. figure:: ../../_static/esp-idf-installer-command-prompt.png
:align: center
:alt: ESP-IDF Command Prompt
:figclass: align-center
ESP-IDF Command Prompt
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
Using the Command Prompt
========================
Updated get started instructions for windows following https://esp32.com/viewtopic.php?f=13&t=4232
2018-01-24 14:41:35 -05: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
For the remaining Getting Started steps, we're going to use the Windows Command Prompt.
Getting started guides
2017-03-26 18:01:52 -04:00
docs: Update FreeRTOS version, add tips to set up instructions for Windows
2021-01-22 02:51:15 -05:00
ESP-IDF Tools Installer also creates a shortcut in the Start menu to launch the ESP-IDF Command Prompt. This shortcut launches the Command Prompt (cmd.exe) and runs ``export.bat`` script to set up the environment variables (``PATH``, ``IDF_PATH`` and others). Inside this command prompt, all the installed tools are available.
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 that this shortcut is specific to the ESP-IDF directory selected in the ESP-IDF Tools Installer. If you have multiple ESP-IDF directories on the computer (for example, to work with different versions of ESP-IDF), you have two options to use them:
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
1. Create a copy of the shortcut created by the ESP-IDF Tools Installer, and change the working directory of the new shortcut to the ESP-IDF directory you wish to use.
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
2. Alternatively, run ``cmd.exe``, then change to the ESP-IDF directory you wish to use, and run ``export.bat``. Note that unlike the previous option, this way requires Python and Git to be present in ``PATH``. If you get errors related to Python or Git not being found, use the first option.
Getting started guides
2017-03-26 18:01:52 -04:00
Next Steps
==========
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
If the ESP-IDF Tools Installer has finished successfully, then the development environment setup is complete. Proceed directly to :ref:`get-started-start-project`.
Getting started guides
2017-03-26 18:01:52 -04:00
Related Documents
=================
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
For advanced users who want to customize the install process:
Getting started guides
2017-03-26 18:01:52 -04:00
.. toctree::
:maxdepth: 1
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
windows-setup-update
Getting started guides
2017-03-26 18:01:52 -04:00
doc: Getting Started Guide, remove shortcuts to 'build toolchain from scratch' instructions
2020-09-03 14:05:24 -04:00
docs: Fix broken URLs & permanent redirects
2020-03-22 19:27:51 -04:00
.. _MSYS2: https://www.msys2.org/
docs: add ESP-IDF Windows Installation limitations.
2020-11-24 08:09:38 -05:00
.. _CMake: https://cmake.org/download/
.. _Ninja: https://ninja-build.org/
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/
.. _Git for Windows: https://gitforwindows.org/
.. _Github Desktop: https://desktop.github.com/
Reference in New Issue Copy Permalink