VSCode Extension Setup Guide

docs/en/get-started/index.rst

@@ -48,10 +48,16 @@ Hardware:
 
 Software:
 
+
+.. note::
+
+    If you are using our official `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin>`_ or `VSCode Extension <https://github.com/espressif/vscode-esp-idf-extension>`_ then you can skip downloading esp-idf and toolchain manually and instead follow onboarding process from the IDEs itself, `Eclipse Plugin Installing IDF Plugin <https://github.com/espressif/idf-eclipse-plugin#installing-idf-plugin-using-update-site-url>`_ or `VSCode Extension Onboarding <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/ONBOARDING.md>`_
+
+
+* **IDE** of your choice to write programs in C, we have official support for `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin>`_ and :doc:`VSCode Extension <vscode-setup>`
 * **Toolchain** to compile code for {IDF_TARGET_NAME}
 * **Build tools** - CMake and Ninja to build a full **Application** for {IDF_TARGET_NAME}
 * **ESP-IDF** that essentially contains API (software libraries and source code) for {IDF_TARGET_NAME} and scripts to operate the **Toolchain**
-* **Text editor** to write programs (**Projects**) in C, e.g., `Eclipse <https://www.eclipse.org/>`_
 
 
 .. figure:: ../../_static/what-you-need.png
@@ -529,7 +535,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 IDE instead of running ``idf.py``, check out the :doc:`Eclipse guide <eclipse-setup>`.
+If you'd like to use the Eclipse/VSCode IDE instead of running ``idf.py``, check out the :doc:`Eclipse guide <eclipse-setup>`, :doc:`VSCode guide <vscode-setup>`.
 
 
 .. _get-started-build-monitor:
@@ -623,6 +629,7 @@ Related Documents
 
     establish-serial-connection
     eclipse-setup
+    vscode-setup
     ../api-guides/tools/idf-monitor
     toolchain-setup-scratch
     :esp32: ../get-started-legacy/index

docs/en/get-started/vscode-setup.rst

@@ -0,0 +1,34 @@
+********************************
+Getting Started with VS Code IDE
+********************************
+
+
+We have official support for VS 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
+===================
+
+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>`_.
+
+Supported Features
+==================
+
+* **Onboarding**, 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.
+* **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.
+* **IDF Size Analysis Overview** presents an UI for binary size analysis.
+* **`Rainmaker Cloud <https://rainmaker.espressif.com/>`_**, we have inbuilt Rainmaker Cloud support where you can edit/read state of your connected IoT devices easily.
+* **Code Coverage**, we have inbuilt code coverage support which shall highlight in color which line have been covered. We also render the existing HTML report 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 to ask your question in the `forum <http://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 request, most of the features we have today is result of people asking it to implement, or improve certain aspect of the extension, `raise your feature request on github <http://github.com/espressif/vscode-esp-idf-extension/issues/new/choose>`_.

docs/zh_CN/get-started/index.rst

@@ -531,6 +531,7 @@ Windows 操作系统
 
     establish-serial-connection
     eclipse-setup
+    vscode-setup
     ../api-guides/tools/idf-monitor
     toolchain-setup-scratch
     :esp32: ../get-started-legacy/index

docs/zh_CN/get-started/vscode-setup.rst

@@ -0,0 +1 @@
+.. include:: ../../en/get-started/vscode-setup.rst