Skip to content

Commit 0db7980

Browse files
author
Pofkinas
committed
[DOCS] Update README
1 parent 1dba256 commit 0db7980

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ It provides lightweight, efficient low‐level hardware access via STM32 Low‑L
1515
- [2. Project Layout](#2-project-layout)
1616
- [3. Configure Include Paths](#3-configure-include-paths)
1717
- [4. Define Platform Config](#4-define-platform-config)
18+
- [Examples](#examples)
1819
- [Building](#building)
1920
- [STM32CubeIDE](#stm32cubeide)
2021
- [Makefile / CMake](#makefile--cmake)
@@ -46,7 +47,9 @@ pdf/
4647
│ ├── Libs/ # External libraries
4748
│ │ └── VL53L0X
4849
│ └── Utility/ # Utility modules
49-
│ └── Led_animation
50+
│ │ └── Led_animation
51+
└── Examples/
52+
└── Blink_LED/ # Example: Custom CLI + LED blink
5053
```
5154

5255
## Getting Started
@@ -107,6 +110,18 @@ Add preprocessor define in ordef for the framework to pick up configuration `pla
107110

108111
---
109112

113+
## Examples
114+
115+
`/Examples` folder contains preffered file structure with ready‑to‑build demos.
116+
To test framework, build and upload `/Blink_LED` example, transmit over UART fallowing message. You should see onboard LED blinking
117+
118+
```text
119+
project_led_blink:x,y,z
120+
x - LED number (1)
121+
y - blink time (s) (1 ÷ 59)
122+
z - blink frequency (Hz) (2 ÷ 100)
123+
```
124+
110125
## Building
111126

112127
PDF supports build systems:

0 commit comments

Comments
 (0)