mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
Merge branch 'docs/update_ide_documentation' into 'master'
docs: deleted IDE documentation and provided links to these IDE GitHub repos Closes DOC-3254, DOC-2982, and DOC-2961 See merge request espressif/esp-idf!18627
This commit is contained in:
Wang Fang
commit
a8aead1986
@ -22,7 +22,7 @@ Debugging functionality is provided out of box in standard Eclipse installation.
|
||||
|
||||
To begin with, install "GDB Hardware Debugging" plugin by opening Eclipse and going to `Help` > `Install` New Software.
|
||||
|
||||
Once installation is complete, configure debugging session following steps below. Please note that some of configuration parameters are generic and some are project specific. This will be shown below by configuring debugging for "blink" example project. If not done already, add this project to Eclipse workspace following guidance in section :doc:`Build and Flash with Eclipse IDE <../../get-started/eclipse-setup>`. The source of :example:`get-started/blink` application is available in :idf:`examples` directory of ESP-IDF repository.
|
||||
Once installation is complete, configure debugging session following steps below. Please note that some of configuration parameters are generic and some are project specific. This will be shown below by configuring debugging for "blink" example project. If not done already, add this project to Eclipse workspace following guidance in `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README.md>`_. The source of :example:`get-started/blink` application is available in :idf:`examples` directory of ESP-IDF repository.
|
||||
|
||||
1. In Eclipse go to `Run` > `Debug Configuration`. A new window will open. In the window's left pane double click "GDB Hardware Debugging" (or select "GDB Hardware Debugging" and press the "New" button) to create a new configuration.
|
||||
|
||||
@ -30,7 +30,7 @@ Once installation is complete, configure debugging session following steps below
|
||||
|
||||
3. On the "Main" tab below, under "Project:", press "Browse" button and select the "blink" project.
|
||||
|
||||
4. In next line "C/C++ Application:" press "Browse" button and select "blink.elf" file. If "blink.elf" is not there, then likely this project has not been build yet. See :doc:`Build and Flash with Eclipse IDE <../../get-started/eclipse-setup>` how to do it.
|
||||
4. In next line "C/C++ Application:" press "Browse" button and select "blink.elf" file. If "blink.elf" is not there, then likely this project has not been build yet. See `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README.md>`_ how to do it.
|
||||
|
||||
5. Finally, under "Build (if required) before launching" click "Disable auto build".
|
||||
|
||||
|
||||
@ -166,8 +166,8 @@ Other installation methods
|
||||
Depending on the environment, more user-friendly wrappers for ``idf_tools.py`` are provided:
|
||||
|
||||
* :ref:`IDF Tools installer for Windows <get-started-windows-tools-installer>` can download and install the tools. Internally the installer uses ``idf_tools.py``.
|
||||
* :doc:`Eclipse plugin for ESP-IDF <../../get-started/eclipse-setup>` includes a menu item to set up the tools. Internally the plugin calls ``idf_tools.py``.
|
||||
* Visual Studio Code extension for ESP-IDF includes an onboarding flow. This flow helps setting up the tools. Although the extension does not rely on ``idf_tools.py``, the same installation method is used.
|
||||
* `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README.md>`_ includes a menu item to set up the tools. Internally the plugin calls ``idf_tools.py``.
|
||||
* `VSCode Extension <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_ for ESP-IDF includes an onboarding flow. This flow helps setting up the tools. Although the extension does not rely on ``idf_tools.py``, the same installation method is used.
|
||||
|
||||
Custom installation
|
||||
-------------------
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
********************************
|
||||
Build and Flash with Eclipse IDE
|
||||
********************************
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
ESP-IDF V4.0 has a new CMake-based build system as the default build system.
|
||||
|
||||
There is a new ESP-IDF Eclipse Plugin that works with the CMake-based build system. Please refer to `Espressif IDF Eclipse Plugins <https://github.com/espressif/idf-eclipse-plugin/blob/master/README.md>`_ IDF for further instructions.
|
||||
|
||||
.. note::
|
||||
|
||||
In `Espressif IDF Eclipse Plugins <https://github.com/espressif/idf-eclipse-plugin/blob/master/README.md>`_, though screenshots are captured from macOS, installation instructions are applicable for Windows, Linux and macOS.
|
||||
@ -154,11 +154,8 @@ IDE
|
||||
|
||||
.. note:: We highly recommend installing the ESP-IDF through your favorite IDE.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Eclipse Plugin <eclipse-setup>
|
||||
VSCode Extension <vscode-setup>
|
||||
* `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README.md>`_
|
||||
* `VSCode Extension <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_
|
||||
|
||||
Manual Installation
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@ -249,12 +249,16 @@ Once the new tools are installed, update the environment using the Export script
|
||||
Related Documents
|
||||
=================
|
||||
|
||||
* :doc:`establish-serial-connection`
|
||||
* `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README.md>`_
|
||||
* `VSCode Extension <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_
|
||||
* :doc:`../api-guides/tools/idf-monitor`
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 1
|
||||
|
||||
establish-serial-connection
|
||||
eclipse-setup
|
||||
vscode-setup
|
||||
../api-guides/tools/idf-monitor
|
||||
|
||||
.. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository
|
||||
|
||||
@ -293,7 +293,7 @@ When flashing, you will see the output log similar to the following:
|
||||
|
||||
If there are no issues by the end of the flash process, the board will reboot and start up the “hello_world” application.
|
||||
|
||||
If you'd like to use the Eclipse or VS Code IDE instead of running ``idf.py``, check out the :doc:`Eclipse guide <eclipse-setup>`, :doc:`VS Code guide <vscode-setup>`.
|
||||
If you'd like to use the Eclipse or VS Code IDE instead of running ``idf.py``, check out `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README.md>`_, `VSCode Extension <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_.
|
||||
|
||||
Monitor the Output
|
||||
==================
|
||||
|
||||
@ -1,36 +0,0 @@
|
||||
********************************
|
||||
Getting Started with VS Code IDE
|
||||
********************************
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
We have official support for Visual Studio Code and we aim to provide complete end-to-end support for all actions related to ESP-IDF: namely build, flash, monitor, debug, tracing, core-dump, System Trace Viewer, etc.
|
||||
|
||||
Quick Install Guide
|
||||
===================
|
||||
|
||||
The recommended way to install the ESP-IDF Visual Studio Code Extension is by downloading it from `VS Code Marketplace <https://marketplace.visualstudio.com/items?itemName=espressif.esp-idf-extension>`_ or following `Quick Installation Guide <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_.
|
||||
|
||||
Review the `tutorials <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/toc.md>`_ for the ESP-IDF Visual Studio Code Extension to learn how to use all of the features.
|
||||
|
||||
Supported Features
|
||||
==================
|
||||
|
||||
* **Setup**, will help you to quickly install ESP-IDF and its relevant toolchain with just a few clicks.
|
||||
* **Build**, with one-click build and multi-target build, you can easily build and deploy your applications.
|
||||
* **Flash**, with both UART and JTAG flash out-of-the-box.
|
||||
* **Monitoring**, comes with a built-in terminal, you can trigger IDF Monitor Commands from within VS Code as you are used to in traditional terminals.
|
||||
* **Debugging**, with out-of-the-box hardware `debugging <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/debugging.md>`_.
|
||||
* **GUI Menu Config**, provides a simplified UI for configuring your chip.
|
||||
* **App & Heap Tracing**, provides support for collecting traces from your application, and a simplified UI for analyzing them.
|
||||
* **System View Tracing Viewer**, aims to read and display the *.svdat* files into the trace UI (we also support multiple core tracing views).
|
||||
* **IDF Size Analysis Overview** presents a UI for binary size analysis.
|
||||
* **Rainmaker Cloud**, inbuilt Rainmaker Cloud support where you can edit/read the state of your connected IoT devices easily. For more information see the `ESP Rainmaker <https://rainmaker.espressif.com/>`_ page.
|
||||
* **Code Coverage**, inbuilt code coverage support with color highlights showing which lines have been covered. The HTML report renders directly inside the IDE.
|
||||
|
||||
Bugs & Feature Requests
|
||||
=======================
|
||||
|
||||
If you face an issue with certain feature of VS Code or VS Code in general we recommend you ask your question in the `forum <https://esp32.com/viewforum.php?f=40>`_, or open a `GitHub Issue <https://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_ for our dev teams to review.
|
||||
|
||||
We also welcome new feature requests. Most of the features we have today are a result of people asking for them to be implemented. To improve certain aspects of the extension, `raise your feature request on GitHub <http://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_.
|
||||
@ -9,7 +9,7 @@ Introduction
|
||||
|
||||
ESP-IDF requires some prerequisite tools to be installed so you can build firmware for supported chips. The prerequisite tools include Python, Git, cross-compilers, CMake and Ninja build tools.
|
||||
|
||||
For this Getting Started we're going to use the Command Prompt, but after ESP-IDF is installed you can use :doc:`Eclipse <eclipse-setup>` or another graphical IDE with CMake support instead.
|
||||
For this Getting Started we're going to use the Command Prompt, but after ESP-IDF is installed you can use `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README.md>`_ or another graphical IDE with CMake support instead.
|
||||
|
||||
.. note::
|
||||
Limitations:
|
||||
@ -119,13 +119,18 @@ Related Documents
|
||||
|
||||
For advanced users who want to customize the install process:
|
||||
|
||||
* :doc:`windows-setup-update`
|
||||
* :doc:`establish-serial-connection`
|
||||
* `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README.md>`_
|
||||
* `VSCode Extension <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_
|
||||
* :doc:`../api-guides/tools/idf-monitor`
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 1
|
||||
|
||||
windows-setup-update
|
||||
establish-serial-connection
|
||||
eclipse-setup
|
||||
vscode-setup
|
||||
../api-guides/tools/idf-monitor
|
||||
|
||||
.. _CMake: https://cmake.org/download/
|
||||
|
||||
@ -87,3 +87,5 @@ get-started/windows-setup-scratch get-started/windows-setup
|
||||
get-started/linux-setup-scratch get-started/linux-macos-setup
|
||||
get-started/macos-setup-scratch get-started/linux-macos-setup
|
||||
get-started/toolchain-setup-scratch get-started/index
|
||||
get-started/eclipse-setup get-started/index
|
||||
get-started/vscode-setup get-started/index
|
||||
|
||||
@ -22,7 +22,7 @@
|
||||
|
||||
首先，打开 Eclipse 并转到 “Help” > “Install New Software” 来安装 “GDB Hardware Debugging” 插件。
|
||||
|
||||
安装完成后，按照以下步骤配置调试会话。请注意，一些配置参数是通用的，有些则针对特定项目。我们会通过配置 "blink" 示例项目的调试环境来进行展示，请先按照 :doc:`使用 Eclipse IDE 编译和烧写 <../../get-started/eclipse-setup>` 介绍的方法将该示例项目添加到 Eclipse 的工作空间。示例项目 :example:`get-started/blink` 的源代码可以在 ESP-IDF 仓库的 :idf:`examples` 目录下找到。
|
||||
安装完成后，按照以下步骤配置调试会话。请注意，一些配置参数是通用的，有些则针对特定项目。我们会通过配置 "blink" 示例项目的调试环境来进行展示，请先按照 `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README_CN.md>`_ 介绍的方法将该示例项目添加到 Eclipse 的工作空间。示例项目 :example:`get-started/blink` 的源代码可以在 ESP-IDF 仓库的 :idf:`examples` 目录下找到。
|
||||
|
||||
1. 在 Eclipse 中，进入 `Run` > `Debug Configuration`，会出现一个新的窗口。在窗口的左侧窗格中，双击 “GDB Hardware Debugging”(或者选择 “GDB Hardware Debugging” 然后按下 “New” 按钮）来新建一个配置。
|
||||
|
||||
@ -30,7 +30,7 @@
|
||||
|
||||
3. 在下面的 “Main” 选项卡中， 点击 “Project:” 边上的 “Browse” 按钮，然后选择当前的 “blink” 项目。
|
||||
|
||||
4. 在下一行的 “C/C++ Application:” 中，点击 “Browse” 按钮，选择 “blink.elf” 文件。如果 “blink.elf” 文件不存在，那么很有可能该项目还没有编译，请参考 :doc:`使用 Eclipse IDE 编辑和烧写 <../../get-started/eclipse-setup>` 指南中的介绍。
|
||||
4. 在下一行的 “C/C++ Application:” 中，点击 “Browse” 按钮，选择 “blink.elf” 文件。如果 “blink.elf” 文件不存在，那么很有可能该项目还没有编译，请参考 `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README_CN.md>`_ 指南中的介绍。
|
||||
|
||||
5. 最后，在 “Build (if required) before launching” 下面点击 “Disable auto build”。
|
||||
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
****************************************
|
||||
Eclipse IDE 创建和烧录指南
|
||||
****************************************
|
||||
|
||||
:link_to_translation:`en:[English]`
|
||||
|
||||
ESP-IDF V4.0 默认采用基于 CMake 的构建系统。
|
||||
|
||||
针对 CMake 构建系统，ESP-IDF 有一款新的 Eclipse 插件。具体操作指南，请见 `ESP-IDF Eclipse 插件 <https://github.com/espressif/idf-eclipse-plugin/blob/master/README.md>`_。
|
||||
|
||||
.. 注解::
|
||||
|
||||
`ESP-IDF Eclipse 插件 <https://github.com/espressif/idf-eclipse-plugin/blob/master/README.md>`_ 中使用的是 macOS 截图，但安装指南对 Windows、Linux 和 macOS 均适用。
|
||||
@ -154,11 +154,8 @@ IDE
|
||||
|
||||
.. note:: 建议您通过自己喜欢的集成开发环境 (IDE) 安装 ESP-IDF。
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Eclipse Plugin <eclipse-setup>
|
||||
VSCode Extension <vscode-setup>
|
||||
* `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README.md>`_
|
||||
* `VSCode Extension <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_
|
||||
|
||||
手动安装
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@ -249,12 +249,16 @@ ESP-IDF 工具安装器会下载 Github 发布版本中附带的一些工具，
|
||||
相关文档
|
||||
=================
|
||||
|
||||
* :doc:`establish-serial-connection`
|
||||
* `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README_CN.md>`_
|
||||
* `VSCode Extension <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_
|
||||
* :doc:`../api-guides/tools/idf-monitor`
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 1
|
||||
|
||||
establish-serial-connection
|
||||
eclipse-setup
|
||||
vscode-setup
|
||||
../api-guides/tools/idf-monitor
|
||||
|
||||
.. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository
|
||||
|
||||
@ -293,7 +293,7 @@
|
||||
|
||||
如果一切顺利，烧录完成后，开发板将会复位，应用程序 "hello_world" 开始运行。
|
||||
|
||||
如果您希望使用 Eclipse 或是 VS Code IDE，而非 ``idf.py``，请参考 :doc:`Eclipse 指南 <eclipse-setup>`，以及 :doc:`VS Code 指南 <vscode-setup>`。
|
||||
如果您希望使用 Eclipse 或是 VS Code IDE，而非 ``idf.py``，请参考 `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README_CN.md>`_，以及 `VSCode Extension <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_。
|
||||
|
||||
监视输出
|
||||
===============
|
||||
|
||||
@ -1,36 +0,0 @@
|
||||
********************************
|
||||
VS Code IDE 快速入门
|
||||
********************************
|
||||
|
||||
:link_to_translation:`en:[English]`
|
||||
|
||||
我们支持 VS code，并且致力于为所有与 ESP-IDF 相关的操作提供完善的端到端支持，包括构建、烧录、监控、调试、追踪、核心转储 (core-dump)、以及系统追踪查看器等操作。
|
||||
|
||||
快速安装指南
|
||||
===============
|
||||
|
||||
推荐您从 `VS Code 插件市场 <https://marketplace.visualstudio.com/items?itemName=espressif.esp-idf-extension>`_ 中下载 ESP-IDF VS Code 插件，或根据 `快速安装指南 <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_ 安装 ESP-IDF VS Code 插件。
|
||||
|
||||
查看 ESP-IDF VS Code 插件 `教程 <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/toc.md>` 了解如何使用所有功能。
|
||||
|
||||
支持如下功能
|
||||
==================
|
||||
|
||||
* **安装程序**：帮助您迅速安装 ESP-IDF 及其相关工具链。
|
||||
* **构建**：通过一键构建和多目标构建，轻松构建并部署您的应用程序。
|
||||
* **烧录**：UART 和 JTAG 均可完成烧录。
|
||||
* **监控**：内置终端带有监控功能，您可以在 VS Code 中启用 IDF 监控命令，操作方法和传统终端一样。
|
||||
* **调试**：提供立即可用的硬件 `调试 <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/debugging.md>`_ 功能。
|
||||
* **GUI 菜单配置**：提供简化的用户界面，用于配置您的芯片。
|
||||
* **应用程序追踪 & 堆追踪**：支持从应用程序中收集跟踪，并提供简化的用户界面分析跟踪。
|
||||
* **系统视图查看器**：读取并显示 *.svdat* 文件到用户追踪界面，也能同时支持多个内核追踪视图。
|
||||
* **IDF 二进制大小分析**：提供用户界面用于分析二进制文件大小。
|
||||
* **Rainmaker Cloud**：我们有内置的 Rainmaker Cloud 支持，您可以轻松编辑/读取连接的物联网设备的状态。更多信息，请参考 `ESP Rainmaker <https://rainmaker.espressif.com/>`_ 页面。
|
||||
* **代码覆盖**：我们有内置的代码覆盖支持，将用颜色突出显示已经覆盖的行。我们也会在 IDE 内部直接渲染现有的 HTML 报告。
|
||||
|
||||
Bugs 问题 & 功能请求
|
||||
=======================
|
||||
|
||||
如果您在使用 VS Code 或其某些功能上遇到问题，建议您在 `论坛 <https://esp32.com/viewforum.php?f=40>`_ 或是 `GitHub Issue <https://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_ 上提出您的问题，我们开发团队会对问题进行解答。
|
||||
|
||||
我们也欢迎您提出新的功能需求，正是由于用户要求新功能或是建议对现有功能进行改善，才成就我们今天所具备的大多数功能。欢迎您在 `Github <http://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`__ 上提出功能请求。
|
||||
@ -9,7 +9,7 @@ Windows 平台工具链的标准设置
|
||||
|
||||
ESP-IDF 需要安装一些必备工具，才能围绕 {IDF_TARGET_NAME} 构建固件，包括 Python、Git、交叉编译器、CMake 和 Ninja 编译工具等。
|
||||
|
||||
在本入门指南中，我们通过 **命令提示符** 进行有关操作。不过，您在安装 ESP-IDF 后还可以使用 :doc:`Eclipse <eclipse-setup>` 或其他支持 CMake 的图形化工具 IDE。
|
||||
在本入门指南中，我们通过 **命令提示符** 进行有关操作。不过，您在安装 ESP-IDF 后还可以使用 `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README_CN.md>`_ 或其他支持 CMake 的图形化工具 IDE。
|
||||
|
||||
.. note::
|
||||
限定条件：
|
||||
@ -119,13 +119,18 @@ ESP-IDF 工具安装器可在“开始”菜单中，创建一个打开 ESP-IDF
|
||||
|
||||
想要自定义安装流程的高阶用户可参照：
|
||||
|
||||
* :doc:`windows-setup-update`
|
||||
* :doc:`establish-serial-connection`
|
||||
* `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README_CN.md>`_
|
||||
* `VSCode Extension <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_
|
||||
* :doc:`../api-guides/tools/idf-monitor`
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 1
|
||||
|
||||
windows-setup-update
|
||||
establish-serial-connection
|
||||
eclipse-setup
|
||||
vscode-setup
|
||||
../api-guides/tools/idf-monitor
|
||||
|
||||
.. _CMake: https://cmake.org/download/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user