diff options
| author | lonkaars <loek@pipeframe.xyz> | 2024-04-12 17:06:39 +0200 |
|---|---|---|
| committer | lonkaars <loek@pipeframe.xyz> | 2024-04-12 17:06:39 +0200 |
| commit | 898bc5d79c70c859d66b8c1548446c6e45302421 (patch) | |
| tree | cc773bb176cba651198e65121a1d87b60bb251c2 /docs/readme.md | |
| parent | 7dd019030560ad38fe4b93954a3a359ac5e43613 (diff) | |
fix xrefs + add figures
Diffstat (limited to 'docs/readme.md')
| -rw-r--r-- | docs/readme.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/readme.md b/docs/readme.md new file mode 100644 index 0000000..262cac1 --- /dev/null +++ b/docs/readme.md @@ -0,0 +1,23 @@ +# docs + +This folder contains the project documentation in [asciidoc][asciidoc] format. +A makefile is provided for easily compiling these documents into PDFs for +submission. + +## TODO + +- transfer documents + - [ ] project plan + - [ ] requirements + - [ ] research + - [ ] software design +- xrefs for-- + - [x] tables + - [x] figures + - [x] section numbers (headings) + - [ ] requirements +- [x] figures +- [ ] citations +- [ ] glossary +- [ ] PDF style + |