diff --git a/docs/en/additionalfeatures/coredumpdebugging.rst b/docs/en/additionalfeatures/coredumpdebugging.rst index eb0d431b8..ba401ece5 100644 --- a/docs/en/additionalfeatures/coredumpdebugging.rst +++ b/docs/en/additionalfeatures/coredumpdebugging.rst @@ -9,8 +9,8 @@ The IDF-Eclipse plugin allows you to debug the core dump if any crash occurs on To enable core dump debugging for a project: -1. You need to enable it first in ``sdkconfig``. Launch the ``sdkconfig`` in the project root by double-clicking on it which will open the configuration editor. -2. Click on the ``Core Dump`` from the settings on the left and select ``Data Destination`` as ``UART``. +1. You need to enable it first in ``sdkconfig``. Open the ``sdkconfig`` in the project root by double-clicking on it, which will launch the configuration editor. +2. Click ``Core Dump`` in the settings on the left, and set ``Data Destination`` as ``UART``. .. image:: ../../../media/CoreDumpDebugging/sdkconfig_editor.png @@ -18,4 +18,4 @@ This enables core dump debugging. When you connect a serial monitor for the proj You can view the registers and stack trace, and even check the value of variables in the stack frame. -To exit the debug session: simply press the ``stop`` button. +To exit the debug session: simply click the ``stop`` button. diff --git a/docs/en/additionalfeatures/install-esp-components.rst b/docs/en/additionalfeatures/install-esp-components.rst index 9f4b7b22b..d57885295 100644 --- a/docs/en/additionalfeatures/install-esp-components.rst +++ b/docs/en/additionalfeatures/install-esp-components.rst @@ -3,13 +3,13 @@ Install ESP-IDF Components :link_to_translation:`zh_CN:[中文]` -You can install the ESP-IDF Components directly into your project from the available components from the `ESP-IDF Component Registry `_. Follow the steps below: +You can install the ESP-IDF Components directly into your project from the available components in `ESP-IDF Component Registry `_. Follow the steps below: -1. Right-click on the project in ``Project Explorer`` where you want to add the component, and select ``ESP-IDF: Install ESP-IDF Components``. -2. A new window will open, displaying all available components to be installed. -3. In the window, you can click on the ``Install`` button to add the selected component to the project. To access the README file for a component, click ``More Info``, which opens the README in your browser. +1. Right-click on the project where you want to add the component in ``Project Explorer``, and select ``ESP-IDF: Install ESP-IDF Components``. +2. A new window will open, displaying all available components that can be installed. +3. In the window, click the ``Install`` button to add the selected component to your project. To view a component's README file, click ``More Info`` to open the README in your browser. .. image:: ../../../media/ESP-IDF_Components/components_window.png :alt: ESP-IDF Components Window -Already added components are also shown, but the ``Install`` button text changes to ``Already Added`` and is disabled. +Already-added components are also shown, but the ``Install`` button text changes to ``Already Added`` and is disabled. diff --git a/docs/en/debugproject.rst b/docs/en/debugproject.rst index 5baf9b6ab..7615e4444 100644 --- a/docs/en/debugproject.rst +++ b/docs/en/debugproject.rst @@ -1,5 +1,7 @@ Debug Your Project -=============================== +================== + +:link_to_translation:`zh_CN:[中文]` .. |debug_icon| image:: ../../media/icons/debug.png :height: 16px @@ -7,10 +9,11 @@ Debug Your Project In most cases, only two things are required to start debugging an ESP-IDF project: -1. Create a debug configuration -2. Check whether the board in the created configuration corresponds to the board in use. +1. Create a debug configuration. +2. Check whether the board specified in the created configuration matches the board you are using. + +.. note:: -.. note:: If you're using Windows, you may need to install drivers using Zadig to run a debug session successfully. For detailed instructions, please refer to this `guide `_. The fastest way to create a debug configuration is as follows: diff --git a/docs/en/installation.rst b/docs/en/installation.rst index 9ba292866..1896e6b66 100644 --- a/docs/en/installation.rst +++ b/docs/en/installation.rst @@ -29,8 +29,6 @@ Windows For Windows users, Espressif-IDE is available with ESP-IDF as an offline installer. -To download and install it, follow the instructions provided :ref:`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. - macOS/Linux ~~~~~~~~~~~~ @@ -103,5 +101,4 @@ References :maxdepth: 1 Update Site Installation Guide - Windows Offline Installer Configure CDT Build Environment Variables diff --git a/docs/en/windowsofflineinstaller.rst b/docs/en/windowsofflineinstaller.rst deleted file mode 100644 index bcb9bc7dc..000000000 --- a/docs/en/windowsofflineinstaller.rst +++ /dev/null @@ -1,129 +0,0 @@ -.. _windowsofflineinstaller: - -Installing Espressif-IDE by Windows Offline Installer -====================================================== - -`Espressif-IDE with ESP-IDF Windows Offline Installer` is an offline installer that includes all the required components for 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! - - -Download --------- - -You can download the latest version of the installer from `this `_ and run the installer. You can find installer name with ``Espressif-IDE-3.1.1 with ESP-IDF v5.3.1`` or similar name based on the version of the IDE and the version of the ESP-IDF. - -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 - -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 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. 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 :ref:`New Project ` section of the documentation. - -.. image:: ../../media/windows-installation/ide_windows_installer_14.png - :alt: drawing - :width: 400 \ No newline at end of file diff --git a/docs/zh_CN/additionalfeatures/coredumpdebugging.rst b/docs/zh_CN/additionalfeatures/coredumpdebugging.rst index 1315048f3..501debb02 100644 --- a/docs/zh_CN/additionalfeatures/coredumpdebugging.rst +++ b/docs/zh_CN/additionalfeatures/coredumpdebugging.rst @@ -5,7 +5,7 @@ :link_to_translation:`en:[English]` -IDF-Eclipse 插件允许在芯片发生崩溃且已完成相关配置时调试核心转储。目前，仅支持通过 UART 捕获和调试核心转储。 +在完成相关配置的前提下，IDF-Eclipse 插件可以在芯片发生崩溃时调试核心转储。目前，仅支持通过 UART 捕获和调试核心转储。 可参照以下步骤为项目启用核心转储调试： diff --git a/docs/zh_CN/debugproject.rst b/docs/zh_CN/debugproject.rst index 144237842..6481034c4 100644 --- a/docs/zh_CN/debugproject.rst +++ b/docs/zh_CN/debugproject.rst @@ -1 +1,35 @@ -.. include:: ../en/debugproject.rst +调试项目 +======== + +:link_to_translation:`en:[English]` + +.. |debug_icon| image:: ../../media/icons/debug.png + :height: 16px + :align: middle + +在大多数情况下，开始调试 ESP-IDF 项目前只需要完成以下两步： + +1. 创建调试配置。 +2. 检查已创建配置中指定的开发板是否与实际使用的开发板一致。 + +.. note:: + + 如果使用 Windows 操作系统，可能需要通过 Zadig 安装驱动程序，才能成功运行调试会话。有关详细说明，请参考此 `指南 `_。 + +创建调试配置的最快方式如下： + +1. 在启动栏中展开配置列表并点击 ``New Launch Configuration...``。 +2. 选择 ``ESP-IDF GDB OpenOCD Debugging``，然后双击该选项或点击 ``Next``。 +3. 上述选项会打开新的调试配置预览界面，用于查看开发板设置。 + +创建调试配置后，即可继续调试该项目： + +1. 选择刚才创建的配置。 +2. 选择 ``Debug`` 模式。 +3. 点击 ``Debug`` 图标 |debug_icon| 以开始调试。 + + +.. image:: https://github.com/espressif/idf-eclipse-plugin/assets/24419842/1fb0fb9b-a02a-4ed1-bdba-b4b4d36d100f + :alt: 调试过程 + +要了解更多有关调试配置的内容，请参阅 :ref:`ESP-IDF OpenOCD 调试 `。 diff --git a/docs/zh_CN/installation.rst b/docs/zh_CN/installation.rst index cfd33b1b0..e8e501391 100644 --- a/docs/zh_CN/installation.rst +++ b/docs/zh_CN/installation.rst @@ -29,8 +29,6 @@ Windows 对于 Windows 用户，Espressif-IDE 提供带有 ESP-IDF 的离线安装包。 -请参阅 :ref:`此文 ` 下载并安装 Espressif-IDE。该指南将引导你完成 Java、Git、CMake、ESP-IDF、IDF 工具、设备驱动以及 Espressif-IDE 的安装流程，帮助你快速入门。 - macOS/Linux ~~~~~~~~~~~ @@ -103,5 +101,4 @@ Espressif-IDE 提供了工具管理视图，可用来激活可用的 ESP-IDF 版 :maxdepth: 1 更新站点安装指南 - Windows 离线安装程序 配置 CDT 构建环境变量 diff --git a/docs/zh_CN/windowsofflineinstaller.rst b/docs/zh_CN/windowsofflineinstaller.rst deleted file mode 100644 index 85d3edf76..000000000 --- a/docs/zh_CN/windowsofflineinstaller.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../en/windowsofflineinstaller.rst