mirror of
https://github.com/espressif/esp-idf.git
synced 2026-10-02 11:10:54 +03:00
Merge branch 'docs/add_idf_install_flowchart' into 'master'
docs: add flowchart for get-started Closes DOC-13969 See merge request espressif/esp-idf!47477
This commit is contained in:
Wang Ning
@@ -224,6 +224,24 @@ To start using ESP-IDF on **{IDF_TARGET_NAME}**, you need the following software
|
||||
:alt: Development of applications for {IDF_TARGET_NAME}
|
||||
:figclass: align-center
|
||||
|
||||
|
||||
Workflow Overview
|
||||
=================
|
||||
|
||||
Getting started with ESP-IDF involves two main phases:
|
||||
|
||||
1. **Setup** — installing prerequisites and ESP-IDF (see `Installation`_)
|
||||
2. **Develop** — creating, configuring, building, flashing, and monitoring your project (see `Build Your First Project`_)
|
||||
|
||||
If you are unsure where to start, see :doc:`workflow-overview` for a visual overview of the full workflow.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
workflow-overview
|
||||
|
||||
|
||||
.. _get-started-step-by-step:
|
||||
.. _get-started-how-to-get-esp-idf:
|
||||
.. _get-started-set-up-tools:
|
||||
@@ -289,43 +307,10 @@ Uninstall ESP-IDF
|
||||
|
||||
To uninstall ESP-IDF and related tools installed via EIM, you can use either the graphical user interface (GUI) or the command line interface (CLI).
|
||||
|
||||
Uninstall Using EIM GUI
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Launch the ESP-IDF Installation Manager. Under ``Manage Installations``, click ``Open Dashboard``.
|
||||
|
||||
.. figure:: ../../_static/get-started-eim-gui.png
|
||||
:align: center
|
||||
:alt: Open Dashboard in EIM GUI
|
||||
:figclass: align-center
|
||||
|
||||
Open Dashboard in EIM GUI
|
||||
|
||||
To remove a specific ESP-IDF version, click the ``Remove`` button under the version you want to remove.
|
||||
|
||||
To remove all ESP-IDF versions, click ``Purge All`` button at the bottom of the page.
|
||||
|
||||
.. figure:: ../../_static/get-started-eim-gui-uninstall.png
|
||||
:align: center
|
||||
:alt: Uninstall ESP-IDF in EIM GUI
|
||||
:figclass: align-center
|
||||
|
||||
Uninstall ESP-IDF in EIM GUI
|
||||
|
||||
Uninstall Using EIM CLI
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To remove a specific ESP-IDF version, for example v5.4.2, run the following command in your terminal:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
eim remove v5.4.2
|
||||
|
||||
To remove all ESP-IDF versions, run the following command in your terminal:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
eim purge
|
||||
uninstall
|
||||
|
||||
|
||||
Related Documents
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
Uninstall ESP-IDF Using EIM GUI
|
||||
================================
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
Launch the ESP-IDF Installation Manager. Under ``Manage Installations``, click ``Open Dashboard``.
|
||||
|
||||
.. figure:: ../../_static/get-started-eim-gui.png
|
||||
:align: center
|
||||
:alt: Open Dashboard in EIM GUI
|
||||
:figclass: align-center
|
||||
|
||||
Open Dashboard in EIM GUI
|
||||
|
||||
To remove a specific ESP-IDF version, click the ``Remove`` button under the version you want to remove.
|
||||
|
||||
To remove all ESP-IDF versions, click the ``Purge All`` button at the bottom of the page.
|
||||
|
||||
.. figure:: ../../_static/get-started-eim-gui-uninstall.png
|
||||
:align: center
|
||||
:alt: Uninstall ESP-IDF in EIM GUI
|
||||
:figclass: align-center
|
||||
|
||||
Uninstall ESP-IDF in EIM GUI
|
||||
|
||||
Uninstall ESP-IDF Using EIM CLI
|
||||
================================
|
||||
|
||||
To remove a specific ESP-IDF version, for example v5.4.2, run the following command in your terminal:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
eim remove v5.4.2
|
||||
|
||||
To remove all ESP-IDF versions, run the following command in your terminal:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
eim purge
|
||||
@@ -0,0 +1,51 @@
|
||||
Workflow Overview
|
||||
=================
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
The following diagram shows how to set up the environment to use ESP-IDF. The setup flow varies depending on whether you start from an IDE or not, but both paths lead to the same development workflow.
|
||||
|
||||
.. blockdiag:: /../_static/get-started-esp-idf-setup.diag
|
||||
:caption: ESP-IDF Setup Workflow (Click to enlarge)
|
||||
:align: center
|
||||
:scale: 60%
|
||||
:alt: ESP-IDF Setup Workflow
|
||||
|
||||
The following diagram shows how to develop with ESP-IDF.
|
||||
|
||||
.. blockdiag:: /../_static/get-started-esp-idf-develop.diag
|
||||
:caption: ESP-IDF Development Workflow (Click to enlarge)
|
||||
:align: center
|
||||
:scale: 60%
|
||||
:alt: ESP-IDF Development Workflow
|
||||
|
||||
|
||||
Related Documents
|
||||
-----------------
|
||||
|
||||
- Setup workflow
|
||||
|
||||
* Install IDE and plugins
|
||||
|
||||
+ `Espressif-IDE > Prerequisites <https://docs.espressif.com/projects/espressif-ide/en/latest/prerequisites.html>`_
|
||||
+ `Espressif-IDE > Installation <https://docs.espressif.com/projects/espressif-ide/en/latest/installation.html>`_
|
||||
+ `ESP-IDF Extension for VS Code > Prerequisites <https://docs.espressif.com/projects/vscode-esp-idf-extension/en/latest/prerequisites.html>`_
|
||||
+ `ESP-IDF Extension for VS Code > Install ESP-IDF and Tools <https://docs.espressif.com/projects/vscode-esp-idf-extension/en/latest/installation.html>`_
|
||||
|
||||
* Install EIM prerequisites, EIM, and then ESP-IDF via EIM
|
||||
|
||||
+ :doc:`windows-setup`
|
||||
+ :doc:`linux-setup`
|
||||
+ :doc:`macos-setup`
|
||||
|
||||
- Development workflow
|
||||
|
||||
* IDE
|
||||
|
||||
+ `Espressif-IDE > Start Your Project <https://docs.espressif.com/projects/espressif-ide/en/latest/startproject.html>`_
|
||||
+ `ESP-IDF Extension for VS Code > Start a Project <https://docs.espressif.com/projects/vscode-esp-idf-extension/en/latest/startproject.html>`_
|
||||
|
||||
* CLI
|
||||
|
||||
+ :doc:`windows-start-project`
|
||||
+ :doc:`linux-macos-start-project`
|
||||
Reference in New Issue
Block a user