docs readme: update document

Signed-off-by: John Sanpe <[email protected]>
openbfdev · Mar 31, 2024 · 0c0d4a4 · 0c0d4a4
1 parent d89ed41
commit 0c0d4a4
Showing 1 changed file with 20 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,20 @@
-# PY32F0 CMAKE TEMPLATE
+# PY32F0xx CMAKE TEMPLATE
+
+This project demonstrates the operation of bfdev on the PY32F0xx platform.
+
+## How to compile
+
+```
+# apt install gcc-arm-none-eabi
+# ./build.sh
+```
+
+## Run benchmark
+
+Flash the generated image `build/examples/benchmark/benchmark.hex` to stm32 chip.
+
+```
+[info] benchmark: Benchmark for PY32F0xx.
+[info] benchmark: Bfdev version: 1.0.1-devel
+...
+```