summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorHa Thach <[email protected]>2026-02-10 12:54:52 +0700
committerGitHub <[email protected]>2026-02-10 12:54:52 +0700
commite416a81a50483dde140e3bfdc1be8657d44f560e (patch)
tree44f4df082bd7175bcef2a67ec3bc6584f60e433d /docs
parent207396bba68b8eb5243fee81f0c40805032ae41c (diff)
parentb66c3f75c311f1424c6d7085c7fc3ad14c544de6 (diff)
Merge pull request #3437 from hathach/copilot/improve-build-steps-rp2040-esp32
doc update
Diffstat (limited to 'docs')
-rw-r--r--docs/getting_started.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
index 0c3fcec80..8442305d4 100644
--- a/docs/getting_started.rst
+++ b/docs/getting_started.rst
@@ -34,7 +34,10 @@ Get the Code
$ python tools/get_deps.py -b stm32h743eval # or python tools/get_deps.py stm32h7
.. note::
- For rp2040 `pico-sdk <https://github.com/raspberrypi/pico-sdk>`_ or `esp-idf <https://github.com/espressif/esp-idf>`_ for Espressif targets are required; install them per vendor instructions.
+ Some MCU families require additional SDKs, please follow their instructions to install and set it up
+
+ * **rp2040**: Requires `pico-sdk <https://github.com/raspberrypi/pico-sdk>`_
+ * **Espressif (esp32)**: Requires `esp-idf <https://github.com/espressif/esp-idf>`_. Only a few examples support the ESP-IDF build system. Look for ones with `src/CMakeLists.txt` that contain `idf_component_register()`, such as `cdc_msc_freertos`.
Simple Device Example
---------------------