summaryrefslogtreecommitdiffstats
path: root/sandbox/cobra/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'sandbox/cobra/README.md')
-rw-r--r--sandbox/cobra/README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/sandbox/cobra/README.md b/sandbox/cobra/README.md
new file mode 100644
index 00000000..f9bb8026
--- /dev/null
+++ b/sandbox/cobra/README.md
@@ -0,0 +1,34 @@
+
+# usage
+cobra [target...]
+
+# description
+cobra tries to satisfies all specified targets and all of it dependencies.
+
+# targets
+targets can be a lot of different things, e.g. directories
+
+## dirctory targets
+try to do the right thing when the cobra search path contains a directory
+that contains an index.{js,sh,py,etc.} file.
+
+## cobra search path
+like your sh's PATH
+
+## example: cobra as some kind of make
+
+ $ echo $COBRA_PATH
+ .
+ $ ls .
+ foo/ bar/ baz/
+ $ cat foo/cobra.json
+ { "deps": "bar", "baz" }
+ $ cat bar/cobra.json
+ No such file or directory
+ $ cat baz/cobra.json
+ No such file or directory
+ $ cobra foo
+ [cobra bar]
+ [cobra baz]
+ [cobra foo]
+ $ exit