summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhathach <[email protected]>2026-02-07 21:53:51 +0700
committerhathach <[email protected]>2026-02-07 21:53:51 +0700
commit320d0f88bf7f3c8fb9e2e8c86e55051a0d0980aa (patch)
tree4722df72602a6f3be2804cfcec469dfa6b6202c3
parent7921aae6e2f824e217a5cb3da1337876bfd9d3a9 (diff)
remove sdk setup instruction for rp2040 and espressif
-rw-r--r--docs/getting_started.rst130
1 files changed, 3 insertions, 127 deletions
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
index d9d81f23f..b7a962d50 100644
--- a/docs/getting_started.rst
+++ b/docs/getting_started.rst
@@ -34,10 +34,10 @@ Get the Code
$ python tools/get_deps.py -b stm32h743eval # or python tools/get_deps.py stm32h7
.. note::
- Some MCU families require additional SDKs:
+ 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>`_ - see `Building for RP2040`_ below
- * **Espressif (esp32)**: Requires `esp-idf <https://github.com/espressif/esp-idf>`_ - see `Building for ESP32`_ below
+ * **rp2040**: Requires `pico-sdk <https://github.com/raspberrypi/pico-sdk>`_
+ * **Espressif (esp32)**: Requires `esp-idf <https://github.com/espressif/esp-idf>`_
Simple Device Example
---------------------
@@ -152,130 +152,6 @@ A MCU can support multiple operational speed. By default, the example build syst
$ make BOARD=stm32h743eval RHPORT_DEVICE_SPEED=OPT_MODE_FULL_SPEED all
-Building for RP2040
--------------------
-
-RP2040 boards (like Raspberry Pi Pico) require the Pico SDK to be installed and configured before building.
-
-Install Pico SDK
-^^^^^^^^^^^^^^^^
-
-**Linux/macOS:**
-
-.. code-block:: bash
-
- $ cd ~
- $ git clone https://github.com/raspberrypi/pico-sdk.git
- $ cd pico-sdk
- $ git submodule update --init
-
-**Windows:**
-
-.. code-block:: bat
-
- C:\> cd %USERPROFILE%
- C:\Users\YourName> git clone https://github.com/raspberrypi/pico-sdk.git
- C:\Users\YourName> cd pico-sdk
- C:\Users\YourName\pico-sdk> git submodule update --init
-
-Set PICO_SDK_PATH
-^^^^^^^^^^^^^^^^^
-
-Before running cmake, export the SDK path:
-
-**Linux/macOS:**
-
-.. code-block:: bash
-
- $ export PICO_SDK_PATH=~/pico-sdk
-
-**Windows (Command Prompt):**
-
-.. code-block:: bat
-
- C:\> set PICO_SDK_PATH=%USERPROFILE%\pico-sdk
-
-**Windows (PowerShell):**
-
-.. code-block:: powershell
-
- PS C:\> $env:PICO_SDK_PATH = "$env:USERPROFILE\pico-sdk"
-
-Build Example for RP2040
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. code-block:: bash
-
- $ cd examples/device/cdc_msc
- $ cmake -DBOARD=raspberry_pi_pico -B build
- $ cmake --build build
-
-.. tip::
- Add the PICO_SDK_PATH export to your shell's profile file (e.g., ``~/.bashrc``, ``~/.zshrc``) to make it permanent.
-
-
-Building for ESP32
-------------------
-
-ESP32 boards require the ESP-IDF (Espressif IoT Development Framework) to be installed and sourced before building.
-
-Install ESP-IDF
-^^^^^^^^^^^^^^^
-
-**Linux/macOS:**
-
-.. code-block:: bash
-
- $ cd ~
- $ git clone --recursive https://github.com/espressif/esp-idf.git
- $ cd esp-idf
- $ ./install.sh all
-
-**Windows:**
-
-.. code-block:: bat
-
- C:\> cd %USERPROFILE%
- C:\Users\YourName> git clone --recursive https://github.com/espressif/esp-idf.git
- C:\Users\YourName> cd esp-idf
- C:\Users\YourName\esp-idf> install.bat all
-
-Source ESP-IDF Environment
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Before running cmake, source the ESP-IDF export script:
-
-**Linux/macOS:**
-
-.. code-block:: bash
-
- $ source ~/esp-idf/export.sh
-
-**Windows (Command Prompt):**
-
-.. code-block:: bat
-
- C:\> %USERPROFILE%\esp-idf\export.bat
-
-**Windows (PowerShell):**
-
-.. code-block:: powershell
-
- PS C:\> . $env:USERPROFILE\esp-idf\export.ps1
-
-Build Example for ESP32
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. code-block:: bash
-
- $ cd examples/device/cdc_msc
- $ cmake -DBOARD=espressif_s3_devkitc -B build
- $ cmake --build build
-
-.. tip::
- You need to source the ESP-IDF export script in each new terminal session. Consider creating an alias in your shell's profile file for convenience.
-
-
IAR Embedded Workbench
----------------------