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`