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

Merge branch 'feature/guide_change_for_catalina' into 'master'

Browse Source 
docs: Add profile file name used by zsh shell

Closes DOC-325

See merge request espressif/esp-idf!10320
This commit is contained in:
Krzysztof Budzynski 2020-09-11 16:42:30 +08:00
commit 4547c0876a
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/en/get-started/index.rst
View File

@ -262,13 +262,19 @@ In the terminal where you are going to use ESP-IDF, run:
Note the space between the leading dot and the path!
You can also create an alias for the export script to your ``.profile`` or ``.bash_profile`` script. This way you can set up the environment in a new terminal window by typing ``get_idf``:
If you plan to use esp-idf frequently, you can create an alias for executing ``export.sh``:
.. code-block:: bash
1. Copy and paste the following command to your shell's profile (``.profile``, ``.bashrc``, ``.zprofile``, etc.)
alias get_idf='. $HOME/esp/esp-idf/export.sh'
.. code-block:: bash
Note that it is not recommended to source ``export.sh`` from the profile script directly. Doing so activates IDF virtual environment in every terminal session (even in those where IDF is not needed), defeating the purpose of the virtual environment and likely affecting other software.
alias get_idf='. $HOME/esp/esp-idf/export.sh'
2. Refresh the configuration by restarting the terminal session or by running ``source [path to profile]``, for example, ``source ~/.bashrc``.
Now you can run ``get_idf`` to set up or refresh the esp-idf environment in any terminal session.
Technically, you can add ``export.sh`` to your shell's profile directly; however, it is not recommended. Doing so activates IDF virtual environment in every terminal session (including those where IDF is not needed), defeating the purpose of the virtual environment and likely affecting other software.
.. _get-started-start-project: