aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorps-george <george.punter15@imperial.ac.uk>2019-09-04 10:04:53 +0200
committerps-george <george.punter15@imperial.ac.uk>2019-09-04 10:04:53 +0200
commit7c486ffeca1ba71f2438f2f97042e4c6b01ea5ef (patch)
treefebbc822f1b46e5fd325713bf56b125bb464832b
parentc4f8ecb6e9b60e325eccbacfb1f6be038ddb13ba (diff)
downloadFMark-roadmap.tar.gz
FMark-roadmap.zip
Add roadmap to 'feature complete' FMarkroadmap
-rw-r--r--ROADMAP.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/ROADMAP.md b/ROADMAP.md
new file mode 100644
index 0000000..f278765
--- /dev/null
+++ b/ROADMAP.md
@@ -0,0 +1,29 @@
+# Roadmap
+
+## arewecompleteyet?
+
+FMark will be "feature complete" when it is possible to write a typical dissertation entirely in fmarkdown.
+
+- [ ] Stable CLI build released & locked down; generates HTML or PDF.
+- [ ] Be able to process long files without StackOverflow (tail recursive or incremental processing).
+ - Note: With page breaks, could process each "page" individually.
+- [ ] Page breaks/page numbering.
+- [ ] Table of contents
+- [ ] References
+- [ ] Tables
+- [ ] Labels for figures/images/tables
+
+## Extensions
+
+- [ ] Styling
+ - [ ] Easy CSS integration
+ - [ ] Fonts
+ - [ ] Page styling
+- [ ] Formattable $(today) datestamp
+- [ ] References
+ - [ ] Chicago
+ - [ ] Harvard
+
+## Further work
+
+- [ ] Performance/speed test each component (e.g. I have a suspicion our table parsing mechanism could be optimised a lot, but don't know if it's worth it. Let's check which parts are slowly us down the most.)