Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs migration #1076

Merged
merged 21 commits into from
Nov 14, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/en/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ Espressif-IDE is an Integrated Development Environment(IDE) based on Eclipse CDT

The plug-in runs on macOS, Windows and Linux platforms.

.. note::
Espressif-IDE version 3.0 and later supports ESP-IDF version 5.x and above. For ESP-IDF version 4.x and earlier, please use Espressif-IDE version 2.12.1.

Features
----------------

Expand Down Expand Up @@ -37,7 +40,7 @@ Features
For more about this project please see https://github.com/espressif/idf-eclipse-plugin

.. toctree::
:maxdepth: 1
:maxdepth: 2

Prerequisites <prerequisites>
Installation <installation>
Expand Down
4 changes: 2 additions & 2 deletions docs/en/installation.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Installation
===============================
We recommend using the Espressif-IDE instead of the Eclipse CDT + IEP Plugin update approach to avoid the hassles of updating.
To begin, download the Espressif-IDE for your respective operating system.

Windows
-------------------------
Download the Espressif-IDE with ESP-IDF Offline Windows Installer and follow the instructions provided here. This guide will walk you through the installation process for Java, Git, CMake, ESP-IDF, IDF Tools, Device Drivers, and Espressif-IDE to help you get started.
Download the `Espressif-IDE with ESP-IDF Offline Windows Installer <https://dl.espressif.com/dl/esp-idf/>`_ and follow the instructions provided :ref:`here <windowsofflineinstaller>`. This guide will walk you through the installation process for Java, Git, CMake, ESP-IDF, IDF Tools, Device Drivers, and Espressif-IDE to help you get started.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix incomplete download URL.

The download URL for the Windows Installer appears to be incomplete. Please update it with the correct full URL.

Additionally, consider adding version information to help users identify the appropriate installer version.


macOS
---------------------------------
Expand Down
19 changes: 16 additions & 3 deletions docs/en/prerequisites.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,22 @@
Prerequisites
===============================
The minimum requirements for running the Espressif-IDE are below.
The Espressif-IDE is a development environment for Espressif chips using the ESP-IDF framework. It is designed to make development easy and straightforward. This document lists the requirements for installing and running the Espressif-IDE.

Software Prerequisites
-----------------------
The minimum requirements for running the Espressif-IDE are listed below.

- `Java 17 <https://www.oracle.com/technetwork/java/javase/downloads/index.html>`_ and above.
- `Python 3.8 <https://www.python.org/downloads/>`_ and above.
- `Python 3.12 <https://www.python.org/downloads/>`_ and above.
- `Git <https://git-scm.com/downloads>`_.
- Install the following ESP-IDF `Prerequisites <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-macos-setup.html#step-1-install-prerequisites>`_.

.. note::
Ensure that Java, Python, and Git are correctly set up and available in the system's PATH environment variable.
Comment on lines +23 to +24
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Enhance PATH setup instructions

The note about PATH setup could be more helpful by:

  1. Adding instructions for verifying the PATH setup (e.g., java --version, python --version, git --version)
  2. Including OS-specific instructions for modifying PATH
  3. Adding troubleshooting steps for common PATH-related issues



Note: Make sure Java, Python and Git are available on the environment PATH.
Hardware Prerequisites
-----------------------
- A computer running Windows, Linux, or macOS
- An ESP32 development board with a USB to serial interface and/or debug port
- A USB cable (data + power) compatible with your development board
130 changes: 130 additions & 0 deletions docs/en/windowsofflineinstaller.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
.. _windowsofflineinstaller:

Installing Espressif-IDE by Windows Offline Installer
======================================================

Espressif-IDE Installer (All-in-One) is an offline installer and it comes with all the required components to work with the ESP-IDF Application development.

The installer deploys the following components:

- Embedded Python
- Cross-compilers
- OpenOCD
- CMake and Ninja build tools
- ESP-IDF
- Espressif-IDE
- Amazon Corretto OpenJDK

As Installer bundles, all the required components and tools including stable esp-idf so people behind corporate firewalls can use the whole solution out-of-box. This also configures all the required build environment variables and tool paths as you launch the IDE. All you could do is to get started with your project directly without manually configuring anything. This will give you a big boost to your productivity!

More details about the standard setup of toolchain for Windows can be found in the `windows-setup <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/windows-setup.html>`_.

Download
--------

You can download the latest version of the installer from `this <https://dl.espressif.com/dl/esp-idf/>`_ and run the installer. You can find installer name with `espressif-ide-setup-2.10.0-with-esp-idf-5.0.1` or similar name based on the version of the installer and the version of the ESP-IDF.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Improve download section maintainability and clarity.

The current download instructions have several areas for improvement:

  1. The hardcoded version numbers (2.10.0 and 5.0.1) will become outdated.
  2. The download link could be more specific.
  3. The version selection guidance could be clearer.
-You can download the latest version of the installer from `this <https://dl.espressif.com/dl/esp-idf/>`_ and run the installer. You can find installer name with `espressif-ide-setup-2.10.0-with-esp-idf-5.0.1` or similar name based on the version of the installer and the version of the ESP-IDF.
+You can download the latest version of the installer from the `Espressif Download Center <https://dl.espressif.com/dl/esp-idf/>`_. Look for an installer named ``espressif-ide-setup-<IDE_VERSION>-with-esp-idf-<IDF_VERSION>`` (e.g., ``espressif-ide-setup-2.10.0-with-esp-idf-5.0.1``). Choose the version that matches your development requirements.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
You can download the latest version of the installer from `this <https://dl.espressif.com/dl/esp-idf/>`_ and run the installer. You can find installer name with `espressif-ide-setup-2.10.0-with-esp-idf-5.0.1` or similar name based on the version of the installer and the version of the ESP-IDF.
You can download the latest version of the installer from the `Espressif Download Center <https://dl.espressif.com/dl/esp-idf/>`_. Look for an installer named ``espressif-ide-setup-<IDE_VERSION>-with-esp-idf-<IDF_VERSION>`` (e.g., ``espressif-ide-setup-2.10.0-with-esp-idf-5.0.1``). Choose the version that matches your development requirements.


Choose the Installer as shown below.

.. image:: ../../media/windows-installation/ide_windows_installer_0.png

Installation
------------

The installer is an executable file with .exe extension. You can run the installer by double-clicking on it.

The installer will guide you through the installation process. Please find the step-by-step guide below.

Step 1: Choose Language
~~~~~~~~~~~~~~~~~~~~~~~~

Select language for the installer and click Ok.

.. image:: ../../media/windows-installation/ide_windows_installer_1.png
:alt: drawing
Comment on lines +42 to +43
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Improve image accessibility and consistency.

Several images lack meaningful alt text, which is important for accessibility. Additionally, only the last image has a width specification.

For each image, add descriptive alt text and consider standardizing image widths. Example:

-   :alt: drawing
+   :alt: Language selection dialog showing available languages
+   :width: 400

Also applies to: 51-52, 57-58, 63-64, 71-72, 79-82, 87-90, 97-98, 105-106, 113-114, 118-119, 128-130


Step 2: Accept the product license agreement
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Read through the product license agreement, and then select `I accept the agreement`. You must accept the product license in order to continue with the installation. Continue by clicking Next.

.. image:: ../../media/windows-installation/ide_windows_installer_2.png
:alt: drawing

Step 3: Pre-installation checks
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. image:: ../../media/windows-installation/ide_windows_installer_3.png
:alt: drawing

Step 4: Choose the installation directory
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. image:: ../../media/windows-installation/ide_windows_installer_4.png
:alt: drawing

Step 5: Select Components to Install
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

By default all the components are selected. You can deselect any component if you don't want to install it.

.. image:: ../../media/windows-installation/ide_windows_installer_5.png
:alt: drawing

Step 6: Review the installation summary
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

A review summary is presented before the Espressif-IDE and others are installed.

.. image:: ../../media/windows-installation/ide_windows_installer_6.png
:alt: drawing
.. image:: ../../media/windows-installation/ide_windows_installer_7.png
:alt: drawing

Step 6: Finalize the installation
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix step numbering in installation steps.

There's a duplicate "Step 6" in the installation steps. This should be "Step 7", and subsequent steps should be renumbered accordingly.

-Step 6: Finalize the installation
+Step 7: Finalize the installation
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Step 6: Finalize the installation
Step 7: Finalize the installation

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. image:: ../../media/windows-installation/ide_windows_installer_8.png
:alt: drawing
.. image:: ../../media/windows-installation/ide_windows_installer_9.png
:alt: drawing

Step 7: Launch Espressif-IDE
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Launch Espressif-IDE by double-clicking on the icon.

.. image:: ../../media/windows-installation/ide_windows_installer_10.png
:alt: drawing

Step 8: Choose Espressif-IDE Workspace
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

It's advised to select a workspace directory outside the Espressif-IDE Installer folder.

.. image:: ../../media/windows-installation/ide_windows_installer_11.png
:alt: drawing

Step 9: Espressif-IDE Workbench
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

As soon as you launch the Espressif-IDE, it will automatically configure the required environment variables and launch the Welcome page. You can close the Welcome page. You don't need to run any additional install tools from the IDE.

.. image:: ../../media/windows-installation/ide_windows_installer_12.png
:alt: drawing

You can verify the CDT Build environment variables from the Eclipse Preferences.

.. image:: ../../media/windows-installation/ide_windows_installer_13.png
:alt: drawing

Step 10: Build Your First Project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

As IDE already configured with all the required environment variables, you can start with your project.

You can find more details for creating a project in the `New Project <https://github.com/espressif/idf-eclipse-plugin#create-a-new-project>`_ section of the documentation.

.. image:: ../../media/windows-installation/ide_windows_installer_14.png
:alt: drawing
:width: 400
Binary file added media/.DS_Store
Binary file not shown.
Binary file added media/10_serial_terminal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/11_launch_configuration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/12_flashing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/13_sdkconfig_editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/1_idffeature_install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/2_environment_pref.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/3_new_project_default.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/4_new_project_templates.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/5_import_project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/6_core_build_toolchains.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/7_cmake_toolchain.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/8_launch_target.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/9_cmake_build.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/AppLvlTracing_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/AppLvlTracing_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/AppLvlTracing_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/AppLvlTracing_4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/AppLvlTracing_5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/CDT_Build_Console.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/CoreDumpDebugging/sdkconfig_editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/ESP-IDF_Components/components_window.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/ESP-IDF_Components/install_components.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/GDBStubDebugging/code_example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/GDBStubDebugging/debug_panic_mode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/GDBStubDebugging/sdkconfig_editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/HeapTracing/analysis_context_menu.png
Binary file added media/HeapTracing/callers_view.png
Binary file added media/HeapTracing/details_tab_tracing.png
Binary file added media/HeapTracing/heap_tracing_action.png
Binary file added media/HeapTracing/overview_tab_tracing.png
Binary file added media/HeapTracing/show_callers_context_menu.png
Binary file added media/HeapTracing/sysview_heap_log_file.PNG
Binary file added media/IDF_tools_console.png
Binary file added media/JtagFlash_1.png
Binary file added media/JtagFlash_2.png
Binary file added media/JtagFlash_3.png
Binary file added media/OpenOCDDebug_1.png
Binary file added media/OpenOCDDebug_10.png
Binary file added media/OpenOCDDebug_11.png
Binary file added media/OpenOCDDebug_12.png
Binary file added media/OpenOCDDebug_13.png
Binary file added media/OpenOCDDebug_2.png
Binary file added media/OpenOCDDebug_3.png
Binary file added media/OpenOCDDebug_4.png
Binary file added media/OpenOCDDebug_5.png
Binary file added media/OpenOCDDebug_6.png
Binary file added media/OpenOCDDebug_7.png
Binary file added media/OpenOCDDebug_8.png
Binary file added media/OpenOCDDebug_9.png
Binary file added media/Preference_recorder.png
Binary file added media/ToolsValidation/EnvSettings.png
Binary file added media/ToolsValidation/PathVarEdit.png
Binary file added media/ToolsValidation/PathVarEdited.png
Binary file added media/Update_plugins.png
Binary file added media/buildconfiguration_clang.png
Binary file added media/change_language.png
Binary file added media/cland_starting.png
Binary file added media/clangd/build_settings_clang.png
Binary file added media/clangd/cdt_indexer_disable.png
Binary file added media/clangd/cdtlsp_updatesite.png
Binary file added media/clangd/clang_compiler_config.png
Binary file added media/clangd/clangd_config.png
Binary file added media/clangd/clangd_context_help.png
Binary file added media/clangd/clangd_editor.png
Binary file added media/clangd_consolelog_config.png
Binary file added media/clangd_generic_editor.png
Binary file added media/clangd_preference.png
Binary file added media/clangd_proposals.png
Binary file added media/clangd_updatesite.png
Binary file added media/cmake_editor_ca.png
Binary file added media/cmake_editor_preferences.png
Binary file added media/code_analysis_disable_symbols.png
Binary file added media/custombuilddir.png
Binary file added media/espressifide_splash.bmp
Binary file not shown.
Binary file added media/export_log.png
Binary file added media/icons/build.png
Binary file added media/icons/debug.png
Binary file added media/icons/delete.png
Binary file added media/icons/run.png
Binary file added media/icons/terminate.png
Binary file added media/idf_terminal.png
Binary file added media/idf_update_site_install.png
Binary file added media/linux-logo.png
Binary file added media/macos-logo.png
Binary file added media/market_place.png
Binary file added media/sizeanalysis_details.png
Binary file added media/sizeanalysis_overview.png
Binary file added media/windows-logo.png
Binary file added media/zh/10_serial_terminal.png
Binary file added media/zh/11_launch_configuration.png
Binary file added media/zh/1_idffeature_install.png
Binary file added media/zh/2_environment_pref.png
Binary file added media/zh/3_new_project_default.png
Binary file added media/zh/4_new_project_templates.png
Binary file added media/zh/5_import_project.png
Binary file added media/zh/8_launch_target.png
Binary file added media/zh/ESP-IDF_Components/components_window.png
Binary file added media/zh/GDBStubDebugging/code_example.png
Binary file added media/zh/GDBStubDebugging/debug_panic_mode.png
Binary file added media/zh/GDBStubDebugging/sdkconfig_editor.png
Binary file added media/zh/HeapTracing/analysis_context_menu.png
Binary file added media/zh/HeapTracing/callers_view.png
Binary file added media/zh/HeapTracing/details_tab_tracing.png
Binary file added media/zh/HeapTracing/heap_tracing_action.png
Binary file added media/zh/HeapTracing/overview_tab_tracing.png
Binary file added media/zh/HeapTracing/sysview_heap_log_file.PNG
Binary file added media/zh/IDF_tools_console.png
Binary file added media/zh/ToolsManager/git_python_selection.png
Binary file added media/zh/ToolsManager/install_tools_manager.png
Binary file added media/zh/change_language.png
Binary file added media/zh/cmake_editor_preferences.png
Binary file added media/zh/esp_idf_dir.png
Binary file added media/zh/espidf_download.png
Binary file added media/zh/export_log.png
Binary file added media/zh/idf_terminal.png
Binary file added media/zh/idf_update_site_install.png
Binary file added media/zh/sizeanalysis_details.png
Binary file added media/zh/sizeanalysis_overview.png
Loading