Added the generated design docs.

Also explained how to generate them in the README.md file.
This commit is contained in:
2025-07-18 12:25:52 -04:00
parent 1c593aff9b
commit aabcfc6a9a
3 changed files with 25 additions and 0 deletions

View File

@ -93,8 +93,33 @@ To build and flash the program to your Microbit just run:
cargo embed
```
## Documentation
### Design Doc
The [Design Doc][./docs/design.pdf] is generated with pandoc from the markdown
file.
```bash
pandoc ./docs/design.md -o ./docs/design.pdf
```
### Software Design Doc
The [Software Design Doc][./docs/sdd.pdf] is generated with pandoc from the markdown
file.
```bash
pandoc ./docs/sdd.md -o ./docs/sdd.pdf
```
### UML
[UML][./docs/uml/] is generated using Plant UML on the \*.puml files.
```bash
plantuml ./docs/uml/*.puml
```
---
## Copyright & License

BIN
docs/design.pdf Normal file

Binary file not shown.

BIN
docs/sdd.pdf Normal file

Binary file not shown.