Skip to content

Commit 1b7ffda

Browse files
author
Akos Pasztor
committed
Update READMEs
1 parent a03124d commit 1b7ffda

File tree

2 files changed

+20
-4
lines changed

2 files changed

+20
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Customizable Bootloader for STM32 microcontrollers. This project includes demons
44

55
Each example uses the same bootloader library located in the `lib/stm32-bootloader` folder. The examples are located in the `projects` folder and they come with a separate, dedicated README file with description related to that specific implementation.
66

7-
Update: the `STM32L496-Discovery` example supports compiling and building the project with the GNU Arm Embedded Toolchain (ARM GCC) out-of-the-box, in addition to IAR EWARM. Check out the project README for further information.
7+
**Update:** the `STM32L496-Discovery` example supports compiling and building the project with the GNU Arm Embedded Toolchain (ARM GCC) out-of-the-box, in addition to IAR EWARM. Check out the project README for further information.
88

99
Please refer to <https://akospasztor.github.io/stm32-bootloader> for complete documentation of the bootloader library source code.
1010

projects/STM32L496-Discovery/README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,9 @@ After power-up, the bootloader starts. The bootloader checks for user-interactio
5757
*Figure 3: Bootloader sequence*
5858

5959
## Compile & Build
60-
The project can be built out-of-the-box with either IAR EWARM or GNU Arm Embedded Toolchain. The `EWARM` subfolder contains the required files to compile and build the demo with the IAR EWARM toolchain. The `GCC` subfolder contains the compiler-specific files as well as a makefile to easily compile and build the project with the GNU Arm Embedded Toolchain.
60+
The project can be built out-of-the-box with either IAR EWARM or GNU Arm Embedded Toolchain. The `EWARM` subfolder contains the required files to compile and build the demo with the IAR EWARM toolchain.
61+
62+
The `GCC` subfolder contains the compiler-specific files, a `Makefile` and a `SConscript` file to easily compile and build the project with the GNU Arm Embedded Toolchain.
6163

6264
### IAR EWARM
6365
1. Open the `Project.eww` workspace file with IAR.
@@ -68,14 +70,28 @@ Note: The IAR EWARM project is already configured with the required parameters a
6870
### GNU Arm Embedded Toolchain
6971
Prerequisites:
7072
- GNU Arm Embedded Toolchain, recommended version: 8-2019-q3-update
71-
- GNU Make (for Windows, see: [Make for Windows](http://gnuwin32.sourceforge.net/packages/make.htm))
73+
- At least one of the followings:
74+
- GNU Make (for Windows, see: [Make for Windows](http://gnuwin32.sourceforge.net/packages/make.htm))
75+
- Python with pip
76+
77+
#### Build with Make
78+
Steps to compile and build with GNU Make:
7279

73-
Steps to compile and build:
7480
1. If the GNU Arm Embedded Toolchain has not been added to PATH: Edit the `CUSTOMPATH` variable in the `Makefile` so that it points to the `bin` folder of the installed GNU Arm Embedded Toolchain.
7581
2. Open up your favorite terminal and navigate to the `GCC` subfolder where the makefile is located.
7682
3. Type `make` and hit enter.
7783
4. The `build` subfolder should contain the binary, ELF and HEX output files, named `stm32-bootloader.bin`, `stm32-bootloader.elf` and `stm32-bootloader.hex` respectively.
7884

85+
#### Build with SCons
86+
This project currently supports two build configurations: debug (default) and release. Follow these steps to compile and build the project with SCons. Please note that the recommended usage is within a virtualenv.
87+
88+
1. Install the requirements: `pip install -r requirements.txt`
89+
2. If the `bin` folder of the GNU Arm Embedded Toolchain does not exist in the PATH, it can be specified in the `SConstruct` file.
90+
3. To build the project with the default debug configuration, execute: `scons -j8`
91+
4. To build all build configurations at once, execute: `scons --all -j8`
92+
5. To list all supported arguments, execute: `scons --help`
93+
6. The `build` subfolder should contain the generated outputs, organized in subfolders with the names of the build configurations.
94+
7995
## References
8096
[1] 32L496GDISCOVERY, https://www.st.com/en/evaluation-tools/32l496gdiscovery.html
8197

0 commit comments

Comments
 (0)