Generate ocamldoc, multiple documentation fixes.

[goaljobs.git] / NOTES

diff --git a/NOTES b/NOTES
index 385e6b0..28ca33d 100644 (file)
--- a/NOTES
+++ b/NOTES
@@ -75,3 +75,17 @@ Example program:
       git describe --tags --abbrev=0 --match='v*'
     " package in
     require (website_updated version)
+
+This compiles down to a command line program that can be used like this:
+
+  ./compile [-flags] [goals]
+
+The goals are not enabled automatically.  You have to do something
+(simple) to publish a goal and specify how command line arguments get
+mapped to goal arguments, since the mapping is not likely to be 1-1
+strings.  In the end you can do stuff like:
+
+  ./compile all
+  ./compile clean
+  ./compile build program  # program is a parameter
+  ./compile -my-flag       # custom flags can be defined