From 4f00268cfa62ce25dac6ec96233f2e350798b4d4 Mon Sep 17 00:00:00 2001 From: Krzysztof Date: Mon, 7 Sep 2020 03:01:11 +0800 Subject: [PATCH] docs: Add profile file name used by zsh shell --- docs/en/get-started/index.rst | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/en/get-started/index.rst b/docs/en/get-started/index.rst index 30b9e4ac08..03c5829243 100644 --- a/docs/en/get-started/index.rst +++ b/docs/en/get-started/index.rst @@ -219,13 +219,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: