diff --git a/.idea/f103-simon.iml b/.idea/f103-simon.iml index 17625f2..fc8fe8a 100644 --- a/.idea/f103-simon.iml +++ b/.idea/f103-simon.iml @@ -2,6 +2,7 @@ + @@ -23,7 +24,6 @@ - diff --git a/README.md b/README.md index 152a307..4936fdf 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,19 @@ -# STM32F103 CLion / CubeMX boilerplate +# STM32F103 CLion CubeMX boilerplate -Update the init files using STM32CubeMX to fit your project needs. +## Basics -This is a Cmake / CLion project. +- This is a CMake / CLion project, using `arm-none-eabi-gcc` and `arm-none-eabi-newlib`. +- It's built on Linux. Whether it works on Windows or MacOS is left as an exercise to the reader :stuck_out_tongue: +- Update the init files using **STM32CubeMX** to fit your project needs. Open `bluepill.ioc` in CubeMX, then export + to the same folder. +- Since we're using CubeMX, this project is based on HAL. It's not so bad, if you don't look at the source too much. -## Basics +## Getting Started - Usage - The default setup is USART1, 115200 baud, at PA9 (Tx), PA10 (Rx); PC13 as output (built-in LED). - The program branches from `main.c` into `User/user_main.c` where the actual application code starts. -- Initialization of the application code (libs) is done in `User/init.c`. Exception handlers and such are handled in `User/handlers.c`. +- Initialization of the application code (libs) is done in `User/init.c`. Exception handlers and such are handled in + `User/handlers.c`. - Use the included Debounce module for button inputs, Timebase for periodic and future tasks. - Functions from `User/utils/debug.h` print messages to USART1, and work like `printf()`. Regular `printf()` works as well. - Use `malloc_s()` and `calloc_s()` if you want error message on malloc fail instead of a hard fault / memory corruption. diff --git a/STM32F103x6.cmake b/bluepill.cmake similarity index 100% rename from STM32F103x6.cmake rename to bluepill.cmake diff --git a/f103-simon.ioc b/bluepill.ioc similarity index 100% rename from f103-simon.ioc rename to bluepill.ioc diff --git a/f103-simon.xml b/bluepill.xml similarity index 100% rename from f103-simon.xml rename to bluepill.xml