Skip to content

Commit 8b91362

Browse files
committed
Additional STM32 clarificaitons
1 parent 7d0e735 commit 8b91362

File tree

1 file changed

+30
-5
lines changed

1 file changed

+30
-5
lines changed

docs/STM32.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ sudo apt install -y build-essential gcc-arm-none-eabi binutils-arm-none-eabi
99
arm-none-eabi-gcc --version # should print the version
1010
```
1111

12-
The device manufacturer toolchain _also_ needs to be installed. For example without the [STM32CubeIDE Software](https://www.st.com/en/development-tools/stm32cubeide.html),
13-
errors like this will otherwise be encountered:
12+
A device toolchain _also_ needs to be installed. For example without the appropriate support files,
13+
errors like this may otherwise be encountered:
1414

1515
```
1616
[CC ARM] hal/stm32l4.o
@@ -19,27 +19,52 @@ hal/stm32l4.c:24:10: fatal error: stm32l4xx_hal.h: No such file or directory
1919
| ^~~~~~~~~~~~~~~~~
2020
```
2121

22+
There are a variety of other sources for device-specific toolchains, for example:
23+
24+
- [arm-gnu-toolchain-downloads](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads)
25+
- [STM32CubeIDE Software](https://www.st.com/en/development-tools/stm32cubeide.html)
26+
- [gnutoolchains.com](https://gnutoolchains.com/)
27+
- [IAR Embedded Workbench](https://www.iar.com/embedded-development-tools/iar-embedded-workbench)
28+
- [keil](https://www.keil.com/download/product/)
29+
- [llvm](https://releases.llvm.org/download.html)
30+
31+
wolfBoot s supported on nearly every development environment.
32+
2233
## Quick Start
2334

35+
wolfBoot can be used with either `make` or `CMake`.
36+
37+
Be sure to include the submodules when cloning:
38+
2439
```bash
2540
git clone https://github.com/wolfssl/wolfBoot.git
2641
cd wolfBoot
2742
git submodule update --init
43+
```
2844

45+
### make
46+
47+
The `make` builds use the `.config` files. See [config/examples](../config/examples)
48+
49+
```
2950
## Use make
3051
# edit your .config or copy from config/examples
3152
make
53+
```
54+
3255

33-
## OR ##
56+
### CMake
3457

35-
# use cmake via wolfbuild.sh script:
58+
```
59+
## Use CMake
60+
## See wolfboot_cmake_full_build.sh script:
3661
3762
./tools/scripts/wolfboot_cmake_full_build.sh --CLEAN
3863
./tools/scripts/wolfboot_cmake_full_build.sh --CLEAN stm32h7
3964
./tools/scripts/wolfboot_cmake_full_build.sh --target stm32h7
4065
```
4166

42-
### VS Code
67+
## VS Code
4368

4469
Windows users may need one of these:
4570

0 commit comments

Comments
 (0)