cobra: initial README

1 files changed, 33 insertions, 0 deletions

diff --git a/cobra/README b/cobra/README
new file mode 100644
index 00000000..145ecd14
--- /dev/null
+++ b/cobra/README
@@ -0,0 +1,33 @@
+
+# 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