update readme documentation

espressif · Aug 29, 2024 · ada22bd · ada22bd
1 parent 5871bda
commit ada22bd
Show file tree

Hide file tree

Showing 17 changed files with 62 additions and 89 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/C_CPP_CONFIGURATION.md b/docs/C_CPP_CONFIGURATION.md
@@ -1,3 +1,7 @@
+For code navigation the [Microsoft C/C++ Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) or [Clangd extension](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd) can be used for C/C++ language support. By default, projects created with **ESP-IDF: Create Project from Extension Template** or **ESP-IDF: Show Examples Projects** include a template for Microsoft C/C++ extension `c_cpp_properties.json` configuration file and doesn't need to be configured.
+
+Run **ESP-IDF: Run idf.py reconfigure task** to generate the **compile_commands.json** file so language support works.
+
 # Configuration of c_cpp_properties.json File
 
 The [C/C++ Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) can be used to provide C and C++ syntax highlight, code navigation and Go to declaration/definition within C and C++ files.

diff --git a/docs/HARDWARE_SUPPORT.md b/docs/HARDWARE_SUPPORT.md
@@ -1,14 +1,5 @@
 # Current Chips Supported in this Extension
 
-[ESP32](https://www.espressif.com/en/products/socs/esp32)
-[ESP32-C2](https://www.espressif.com/en/products/socs/esp32-c2)
-[ESP32-C3](https://www.espressif.com/en/products/socs/esp32-c3)
-[ESP32-C6](https://www.espressif.com/en/products/socs/esp32-c6)
-[ESP32-S2](https://www.espressif.com/en/products/socs/esp32-s2)
-[ESP32-S3](https://www.espressif.com/en/products/socs/esp32-s3)
-[ESP32-H2](https://www.espressif.com/en/products/socs/esp32-h2)
-[ESP32-P4](https://www.espressif.com/en/products/socs/esp32-p4)
-
 The chips supported in the extension are directly dependent on the ESP-IDF and OpenOCD version you are using:
 
 - The list of OpenOCD configuration boards is obtained from `$OPENOCD_SCRIPTS/esp-config.json` where `$OPENOCD_SCRIPTS` is your OpenOCD Scripts path.

diff --git a/docs/tutorial/install.md b/docs/tutorial/install.md
@@ -76,7 +76,7 @@ To install the nightly build follow the instructions below.
 Nightly builds are available for <a href="https://nightly.link/espressif/vscode-esp-idf-extension/workflows/ci/master/esp-idf-extension.vsix.zip">Visual Studio Code</a> or <a href="https://nightly.link/espressif/vscode-esp-idf-extension/workflows/ci/master/esp-idf-extension-open.vsix.zip">OpenVSX</a>.
 
 - Open VS Code
-- Go to Extensions
+- Click menu `View` and then `Extensions`
 - Click on the `...` from the top and choose `Install from VSIX...`
 - Browse to the VSIX file you downloaded
 - Wait for the extension to install

diff --git a/media/readme/build.png b/media/readme/build.png
diff --git a/media/readme/commandsList.png b/media/readme/commandsList.png
diff --git a/media/readme/espressifIcon.png b/media/readme/espressifIcon.png
diff --git a/media/readme/flash.png b/media/readme/flash.png
diff --git a/media/readme/flashmethod.png b/media/readme/flashmethod.png
diff --git a/media/readme/monitor.png b/media/readme/monitor.png
diff --git a/media/readme/openocd.png b/media/readme/openocd.png
diff --git a/media/readme/sdkconfig.png b/media/readme/sdkconfig.png
diff --git a/media/readme/serialport.png b/media/readme/serialport.png
diff --git a/media/readme/setup.png b/media/readme/setup.png
diff --git a/media/readme/statusBar.png b/media/readme/statusBar.png
diff --git a/media/readme/target.png b/media/readme/target.png
diff --git a/media/youtube_tutorial_preview.png b/media/youtube_tutorial_preview.png