add simple readme as a compile guide

2024-10-04 19:18:22 +09:00 · 2024-10-04 19:18:22 +09:00 · 1af4409ea9
commit 1af4409ea9
parent 0b665fd844
1 changed files with 28 additions and 0 deletions
--- a/examples/stm32/readme.md
+++ b/examples/stm32/readme.md
@ -0,0 +1,28 @@
+# STM32 nanomodbus porting 
+
+## Target hardware
+
+![Blackpill board image](https://dfimg.dfrobot.com/enshop/image/data/DFR0864/Pinout-Diagram.png)
+
+- Blackpill board
+- STM32F401CCUx 
+- USART1 with DMA
+
+## Toolchain and environment
+
+Tested on Mac OS Sonoma(Apple Silicon M1) but other os having same toolchain should have no problem.
+
+- STM32CubeMX 6.11.1
+- arm-none-eabi-gcc 
+- cmake
+- ninja
+- openocd
+- vscode
+  - CMake
+  - cortex-debug
+
+## How to run
+
+1. Generate driver code from stm32f401ccux.ioc using STM32CubeMX
+2. Configure with CMake
+3. Launch with elf file or flash it