summaryrefslogtreecommitdiffstats
path: root/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'README.org')
-rw-r--r--README.org31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.org b/README.org
index 99646c4..88f41f6 100644
--- a/README.org
+++ b/README.org
@@ -91,3 +91,34 @@
the food compiler parses these files into internal C structures, the errors reported are syntax ones
then they can be eval'd which merges any subrecipe ingredients and steps into one plain recipe
+
+* Test commands to create UX
+
+ #+begin_src bash
+ # Common options
+ ## -I /path/:/other/path/:~/.path:and/another/relative/one
+
+ # compile a recipe
+ # Use it when creating a new recipe to verify it's integridy
+ # i.e.
+ # parse the recipe
+ # resolve any includes
+ # merge ingredients
+ # evaluate steps
+ #
+ # also accepts files from stdin
+ recipc [OPTIONS] [FILE...]
+
+ # food
+ ## the main program thing
+ ## OPTIONS include:
+ ### search
+ ### list
+
+ ## FILE is
+ # A collection of recipes from the library
+ # lines are valid food commands (without the executable)
+ # that return one or more recipes fro the library
+ # Some way to set common options might be needed (-I specifically)
+ food [OPTIONS] [FILE]
+ #+end_src