Skip to content

Commit 2e8e0f3

Browse files
committed
README update
1 parent c9ab508 commit 2e8e0f3

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,23 @@
1-
# rig
1+
# rig
2+
3+
## Description
4+
Firmware for a password storage device based on STM32F401CC / STM32F411CC microcontrollers.
5+
Written in C.
6+
7+
## Target Hardware
8+
- MCU: STM32F401CC / STM32F411CC
9+
- Architecture: ARM Cortex-M4
10+
11+
## Functionality
12+
- Secure storage of passwords
13+
- Access to stored data via device interface
14+
15+
## Project Structure
16+
- `app/` — source files
17+
- `config/` — project config
18+
- `platform/` — startup-files, linker scripts etc.
19+
20+
## Requirements
21+
- ARM GCC Toolchain
22+
- STM32 HAL / CMSIS
23+
- Make

0 commit comments

Comments
 (0)