diff options
| author | Ha Thach <[email protected]> | 2021-03-02 12:44:28 +0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-03-02 12:44:28 +0700 |
| commit | a3a9a5efb91b56429ac75c0a81101dedd524eba0 (patch) | |
| tree | cd83f56098b7f2022b5875aff6206bdbc9815241 /docs | |
| parent | 0374e085507cd23124d9cc6d5f2b10565717b72d (diff) | |
| parent | b066fdc2c69591412d2b7c9111a122266cd9f87a (diff) | |
Merge pull request #690 from hathach/submodule-on-the-fly
Submodule on the fly
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/getting_started.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/getting_started.md b/docs/getting_started.md index dfdf02562..870491fe2 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -39,13 +39,13 @@ $ git clone https://github.com/hathach/tinyusb tinyusb $ cd tinyusb ``` -TinyUSB examples includes external repos aka submodules to provide low-level MCU peripheral's driver as well as external libraries such as FreeRTOS to compile with. Therefore we will firstly fetch those mcu driver repo by running this command in the top folder repo +Some TinyUSB examples also requires external submodule libraries in `/lib` such as FreeRTOS, Lightweight IP to build. Run following command to fetch them ``` -$ git submodule update --init --recursive +$ git submodule update --init lib ``` -It will takes a bit of time due to the number of supported MCUs, luckily we only need to do this once. Or if you only want to test with a specific mcu, you could only fetch its driver submodule. +In addition, MCU driver submodule is also needed to provide low-level MCU peripheral's driver. Luckily, it will be fetched if needed when you run the `make` to build your board. ### Build |