alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'enhance/update-vscode-setup-docs-v4.3' into 'release/v4.3'

Browse Source 
docs: Fix vscode extension setup links (backport v4.3)

See merge request espressif/esp-idf!13322
This commit is contained in:
Krzysztof Budzynski 2021-06-16 02:56:46 +00:00
commit 9fde997b5c
4 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/get-started/index.rst
View File

@ -74,7 +74,7 @@ You have a choice to either download and install the following software manually
**or** get through the onboarding process using the following official plugins for integrated development environments (IDE) described in separate documents
* `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin>`_ (`installation link <https://github.com/espressif/idf-eclipse-plugin#installing-idf-plugin-using-update-site-url>`_)
* `VS Code Extension <https://github.com/espressif/vscode-esp-idf-extension>`_ (`onboarding <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/ONBOARDING.md>`_)
* `VS Code Extension <https://github.com/espressif/vscode-esp-idf-extension>`_ (`setup <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_)
.. figure:: ../../_static/what-you-need.png
:align: center

10
docs/en/get-started/vscode-setup.rst
View File

@ -9,16 +9,18 @@ We have official support for VS Code and we aim to provide complete end to end s
Quick Install Guide
===================
Recommended way to install 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/#quick-installation-guide>`_.
Recommended way to install 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 ESP-IDF Visual Studio Code Extension to learn how to use all features.
Supported Features
==================
* **Onboarding**, will help you to quickly install ESP-IDF and its relevant toolchain with just few clicks.
* **Setup**, will help you to quickly install ESP-IDF and its relevant toolchain with just 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 inbuilt terminal where you can trigger IDF Monitor Commands from within VS Code as you are used to in traditional terminals.
* **Debugging**, with out of box hardware debugging and also support for postmortem debugging like core-dump, you can analyze the bugs with convenience.
* **Monitoring** comes with built-in terminal where you can trigger IDF Monitor Commands from within VS Code as you are used to in traditional terminals.
* `Debugging <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/debugging.md>`, with out of box hardware debugging and also support for postmortem debugging like core-dump, you can analyze the bugs with convenience.
* **GUI Menu Config**, provides with simplified UI for configuring your chip.
* **App & Heap Tracing**, provides support for collecting traces from your application and simplified UI for analyzing them.
* **System View Tracing Viewer**, aims to read and display the *.svdat* files into trace UI, we also support multiple core tracing views.

2
docs/zh_CN/get-started/index.rst
View File

@ -74,7 +74,7 @@
或者，您也可以通过以下集成开发环境 (IDE) 中的官方插件完成安装流程：
* `Eclipse 插件 <https://github.com/espressif/idf-eclipse-plugin>`_ (`安装 <https://github.com/espressif/idf-eclipse-plugin#installing-idf-plugin-using-update-site-url>`__)
* `VS Code 插件 <https://github.com/espressif/vscode-esp-idf-extension>`_ (`安装 <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/ONBOARDING.md>`__)
* `VS Code 插件 <https://github.com/espressif/vscode-esp-idf-extension>`_ (`安装 <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`__)
.. figure:: ../../_static/what-you-need.png
:align: center

7
docs/zh_CN/get-started/vscode-setup.rst
View File

@ -10,17 +10,18 @@ VS Code IDE 快速入门
快速安装指南
===============
推荐您从 `VS Code 插件市场 <https://marketplace.visualstudio.com/items?itemName=espressif.esp-idf-extension>`_ 中下载 ESP-IDF VS Code 插件，或根据 `快速安装指南 <https://github.com/espressif/vscode-esp-idf-extension/#quick-installation-guide>`_ 安装 ESP-IDF VS Code 插件。
推荐您从 `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 及其相关工具链。
* **安装程序**：帮助您迅速安装 ESP-IDF 及其相关工具链。
* **构建**：通过一键构建和多目标构建，轻松构建并部署您的应用程序。
* **烧录**：UART 和 JTAG 均可完成烧录。
* **监控**：内置终端带有监控功能，您可以在 VS Code 中启用 IDF 监控命令，操作方法和传统终端一样。
* **调试**：提供立即可用的硬件调试功能，同时支持事后剖析调试如 core-dump 功能，分析 bug 更加方便。
* `调试 <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/debugging.md>`：提供立即可用的硬件调试功能，同时支持事后剖析调试如 core-dump 功能，分析 bug 更加方便。
* **GUI 菜单配置**：提供简化的用户界面，用于配置您的芯片。
* **应用程序追踪 & 堆追踪**：支持从应用程序中收集跟踪，并提供简化的用户界面分析跟踪。
* **系统视图查看器**：读取并显示 *.svdat* 文件到用户追踪界面，同时支持多个内核追踪视图。