blob: bf7eafe55c7fb0afab69159b86ca156c2d27e024 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
|
# docs
This folder contains the project documentation in [AsciiDoc][asciidoc] format.
To compile the documents, make sure you have [Ruby][rubydl] and the
dependencies installed by running the `bundle` command in this folder. A
makefile is provided for convenience.
## TODO
- transfer documents
- [x] project plan
- [x] requirements
- [ ] research
- [ ] software design
- xrefs for--
- [x] tables
- [x] figures
- [x] section numbers (headings)
- [x] requirements
- [x] figures
- [x] citations
- [ ] glossary
- [ ] PDF style
[rubydl]: https://www.ruby-lang.org/en/documentation/installation/
[asciidoc]: https://asciidoc.org/
|