aboutsummaryrefslogtreecommitdiff
path: root/docs/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/readme.md')
-rw-r--r--docs/readme.md23
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
+