Mirrors/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-10-03 03:31:41 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: updated get started for EIM

Browse Source
This commit is contained in:
Wang Ning
2026-01-14 15:53:03 +08:00
parent b685c0e733
commit da60c9a697
57 changed files with 1267 additions and 559 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/get-started/linux-macos-start-project.rst
+52 -3
View File
@@ -1,10 +1,53 @@
Now since all requirements are met, the next topic will guide you on how to start your first project.
****************************************************
Start a Project on Linux and macOS from Command Line
****************************************************
This guide helps you on the first steps using ESP-IDF. Follow this guide to start a new project on the {IDF_TARGET_NAME} and build, flash, and monitor the device output.
This guide helps you to start a new project on the {IDF_TARGET_NAME} and build, flash, and monitor the device output on Linux and macOS.
.. _get-started-set-up-env-linux-macos:
Activate the Environment
========================
.. note::
If you have not yet installed ESP-IDF, please go to :ref:`get-started-step-by-step` and follow the instruction in order to get all the software needed to use this guide.
This section describes the default and recommended procedures to activate the environment from ESP-IDF v6.0. If you use the :doc:`legacy installation method on Linux and macOS <linux-macos-setup-legacy>`, skip this section.
Before using ESP-IDF tools in the terminal, you must activate the ESP-IDF environment. You can do this either via the GUI or CLI.
- `Activate Using EIM GUI`_
- `Activate Using EIM CLI`_
Activate Using EIM GUI
~~~~~~~~~~~~~~~~~~~~~~
.. include:: eim-gui-activate-env.rst
Activate Using EIM CLI
~~~~~~~~~~~~~~~~~~~~~~
Upon successful installation of ESP-IDF, the EIM CLI prints a command to activate the ESP-IDF environment. For example:
.. code-block:: bash
:emphasize-lines: 6
You have successfully installed ESP-IDF
for using the ESP-IDF tools inside the terminal, you will find activation scripts inside the base install folder
sourcing the activation script will setup environment in the current terminal session
============================================
to activate the environment, run the following command in your terminal:
source "/Users/username/.espressif/tools/activate_idf_v5.4.2.sh"
============================================
Run the highlighted command in your terminal:
.. code-block:: bash
source "/Users/username/.espressif/tools/activate_idf_v5.4.2.sh"
Once done, you have successfully activated the ESP-IDF environment in your terminal. All subsequent ESP-IDF commands should be run in this activated terminal.
Start a Project
===================
@@ -24,6 +67,8 @@ Copy the project :example:`get-started/hello_world` to ``~/esp`` directory:
.. note:: There is a range of example projects in the :idf:`examples` directory in ESP-IDF. You can copy any project in the same way as presented above and run it. It is also possible to build examples in-place without copying them first.
.. _get-started-connect-linux-macos:
Connect Your Device
===================
@@ -40,6 +85,8 @@ If you are not sure how to check the serial port name, please refer to :doc:`est
Keep the port name handy as it is needed in the next steps.
.. _get-started-configure-linux-macos:
Configure Your Project
======================
@@ -93,3 +140,5 @@ You are using this menu to set up project specific variables, e.g., Wi-Fi networ
``USB CDC``
3. Save the new configuration and exit the ``menuconfig`` screen.
.. include:: start-project.rst