Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Small fixes/updates to toolchain installation procedures

Browse source
This commit is contained in:
krzychb 2017-05-24 07:00:43 +02:00
parent ba55461686
commit d12f871be6
3 changed files with 25 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
docs/_static/msys2-terminal-window.png vendored
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 5.6 KiB

17
docs/get-started/linux-setup.rst
View file

@ -1,4 +1,4 @@
*************************************
*************************************
Standard Setup of Toolchain for Linux
*************************************
@ -34,7 +34,7 @@ ESP32 toolchain for Linux is available for download from Espressif website:
https://dl.espressif.com/dl/xtensa-esp32-elf-linux32-1.22.0-61-gab8375a-5.2.0.tar.gz
Download this file, then extract it in ``~/esp`` directory::
1. Download this file, then extract it in ``~/esp`` directory::
mkdir -p ~/esp
cd ~/esp
@ -42,7 +42,7 @@ Download this file, then extract it in ``~/esp`` directory::
.. _setup-linux-toolchain-add-it-to-path:
The toolchain will be extracted into ``~/esp/xtensa-esp32-elf/`` directory.
2. The toolchain will be extracted into ``~/esp/xtensa-esp32-elf/`` directory.
To use it, you will need to update your ``PATH`` environment variable in ``~/.bash_profile`` file. To make ``xtensa-esp32-elf`` available for all terminal sessions, add the following line to your ``~/.bash_profile`` file::
@ -54,6 +54,17 @@ Alternatively, you may create an alias for the above command. This way you can g
Then when you need the toolchain you can type ``get_esp32`` on the command line and the toolchain will be added to your ``PATH``.
3. Finally, run the following command to verify if ``PATH`` is correctly set::
printenv PATH
You are looking for similar result containing toolchain's path at the end of displayed string::
$ printenv PATH
/home/user-name/bin:/home/user-name/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin:/home/user-name/esp/xtensa-esp32-elf/bin
Instead of ``/home/user-name`` there should be a home path specific to your installation.
Arch Linux Users
----------------

6
docs/get-started/windows-setup.rst
View file

@ -21,14 +21,14 @@ Unzip the zip file to ``C:\`` (or some other location, but this guide assumes ``
Check it Out
============
Open an MSYS2 terminal window by running ``C:\msys32\mingw32.exe``. The environment in this window is a bash shell.
Open a MSYS2 MINGW32 terminal window by running ``C:\msys32\mingw32.exe``. The environment in this window is a bash shell.
.. figure:: ../_static/msys2-terminal-window.png
:align: center
:alt: MSYS2 terminal window
:alt: MSYS2 MINGW32 shell window
:figclass: align-center
MSYS2 terminal window
MSYS2 MINGW32 shell window
Use this window in the following steps setting up development environment for ESP32.