Installation Manual

2. Get Started on RWF01
Then when you need the toolchain you can type get_esp32 on the command line and
the toolchain will be added to your PATH.
2.2. Get ESP-IDF
Once you have the toolchain (that contains programs to compile and build the
application) installed, you also need ESP32 specific API / libraries. They are provided
by Espressif in
ESP-IDF repository. To get it, open terminal, navigate to the directory
you want to put ESP-IDF, and clone it using git clone command:
cd ~/esp
git clone --recursive https://github.com/espressif/esp-idf.git
ESP-IDF will be downloaded into ~/esp/esp-idf.
Note:
• While cloning submodules on Windows platform, the git clone command may print some output
starting ': not a valid identifier.... This is a known issue but the git clone still succeeds without any
problems.
•
Do not miss the --recursive option. If you have already cloned ESP-IDF without this option, run
another command to get all the submodules:
cd ~/esp/esp-idf
git submodule update --init
2.3. Set up Path to ESP-IDF
The toolchain programs access ESP-IDF using IDF PATH environment variable. This
variable should be set up on your PC, otherwise projects will not build. Setting may be
done manually, each time PC is restarted. Another option is to set up it permanently by
defining IDF PATH in user profile.
To do so, follow instructions specific to :ref:`Windows
<add-idf path-to-profile-windows>`, :ref:`Linux and MacOS <add-idf path-to-profile-linux-
macos>` in section :doc:`add-idf path-to-profile`.
3/8
2019.05