diff --git a/README.md b/README.md index 12f0675..435004b 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/design.pdf b/docs/design.pdf new file mode 100644 index 0000000..1eaf304 Binary files /dev/null and b/docs/design.pdf differ diff --git a/docs/sdd.pdf b/docs/sdd.pdf new file mode 100644 index 0000000..89237d9 Binary files /dev/null and b/docs/sdd.pdf differ