diff options
| author | c1570 <[email protected]> | 2025-10-20 20:56:29 +0200 |
|---|---|---|
| committer | c1570 <[email protected]> | 2025-10-20 21:14:28 +0200 |
| commit | 3cb248f2e59dade48e724946883a6f67de3680e4 (patch) | |
| tree | b09e5c97eb0ff9f78446395f0a247ae624ba8083 | |
| parent | 418239a2165551201ace6ddb49ce327c825e2607 (diff) | |
add note about CMake
| -rw-r--r-- | docs/getting_started.rst | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 84663e486..a3d36a55c 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -7,7 +7,9 @@ This guide will get you up and running with TinyUSB quickly. We'll start with wo Quick Start Examples ==================== -The fastest way to understand TinyUSB is to see it working. These examples demonstrate core functionality and can be built immediately. We'll assume you are using the stm32f407disco board. +The fastest way to understand TinyUSB is to see it working. These examples demonstrate core functionality and can be built immediately. + +We'll assume you are using the stm32f407disco board. For other boards, see ``Board Support Packages`` below. Simple Device Example --------------------- @@ -27,7 +29,7 @@ The `cdc_msc <https://github.com/hathach/tinyusb/tree/master/examples/device/cdc $ cd tinyusb $ python tools/get_deps.py stm32f4 # Download dependencies $ cd examples/device/cdc_msc - $ make BOARD=stm32f407disco all flash + $ make BOARD=stm32f407disco all flash # for CMake based platforms see note below Connect to your computer and you'll see both a new serial port and a small USB drive appear. @@ -48,7 +50,7 @@ The `cdc_msc_hid <https://github.com/hathach/tinyusb/tree/master/examples/host/c $ python tools/get_deps.py stm32f4 # If not done already $ cd examples/host/cdc_msc_hid - $ make BOARD=stm32f407disco all flash + $ make BOARD=stm32f407disco all flash # for CMake platforms see note below Connect USB devices to see enumeration messages and device-specific interactions in the serial output. @@ -133,6 +135,8 @@ Development Tips **CMake build system:** +Used by, e.g., RP2040. + .. code-block:: bash $ mkdir build && cd build |