myrddin/microbadge
1
0
Fork 0
Code Issues 4 Pull Requests Actions Packages Projects 1 Releases Wiki Activity

Adjusted the project structure in the README

Browse Source
This commit is contained in:
Myrddin Dundragon
2025-07-18 12:28:51 -04:00
parent aabcfc6a9a
commit 84ff23655c
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -64,6 +64,9 @@ arithmetic via bounded, clamped, and wrapped integer types.
```text ```text
src/ src/
├── main.rs Entry point of the application. ├── main.rs Entry point of the application.
├── menu/ The Menu Applicaiton.
├── badge/ The Badge Application.
├── snake/ The Snake Application.
``` ```
## Getting Started ## Getting Started
@ -101,7 +104,7 @@ The [Design Doc][./docs/design.pdf] is generated with pandoc from the markdown
file. file.
```bash ```bash
pandoc ./docs/design.md -o ./docs/design.pdf pandoc ./docs/design.md -o ./docs/design.pdf
``` ```
### Software Design Doc ### Software Design Doc
@ -110,7 +113,7 @@ The [Software Design Doc][./docs/sdd.pdf] is generated with pandoc from the mark
file. file.
```bash ```bash
pandoc ./docs/sdd.md -o ./docs/sdd.pdf pandoc ./docs/sdd.md -o ./docs/sdd.pdf
``` ```
### UML ### UML
@ -118,7 +121,7 @@ file.
[UML][./docs/uml/] is generated using Plant UML on the \*.puml files. [UML][./docs/uml/] is generated using Plant UML on the \*.puml files.
```bash ```bash
plantuml ./docs/uml/*.puml plantuml ./docs/uml/*.puml
``` ```
--- ---