changeset 21:10c5e6d11ef8

add notes on future directions
author Jeff Hammel <jhammel@mozilla.com>
date Wed, 03 Aug 2011 09:53:27 -0700
parents 7299c4529b41
children 67e4becc7d49
files README.txt
diffstat 1 files changed, 20 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/README.txt	Tue Aug 02 21:34:59 2011 -0700
+++ b/README.txt	Wed Aug 03 09:53:27 2011 -0700
@@ -1,3 +1,23 @@
 # DocumentIt
 
 Mirror documentation to https://developer.mozilla.org/en/Mozmill
+
+
+## TODO
+
+There are several features that would be nice to have:
+
+- inclusion of other files
+
+- inclusion of `--help` documentation
+
+In general the approach taken shouldn't compromise the general
+approach that the documentation should be the documentation, not
+pre-documentation.  This may be achieved by the use of (e.g. regex)
+macros.  For instance:
+
+    append(--help.*$,shell(mozmill --help))
+
+
+
+