aboutsummaryrefslogtreecommitdiff
path: root/docs/readme.md
blob: 262cac1a7bfef548b05f5ebdf2387e1bf1973139 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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