summaryrefslogtreecommitdiff
path: root/examples/naval
diff options
context:
space:
mode:
authorArmin Ronacher <armin.ronacher@active-4.com>2014-05-14 14:51:11 +0200
committerArmin Ronacher <armin.ronacher@active-4.com>2014-05-14 14:51:26 +0200
commit7acef5fe75490773e7c832e7c27f1cea2f37cc2d (patch)
tree3ff3c68950a38c3f0670a6bdf4701d16b85aae2f /examples/naval
parente4d700e94f0dd08fea6427aea7abd394aa1f13b5 (diff)
downloadclick-7acef5fe75490773e7c832e7c27f1cea2f37cc2d.tar.gz
Added readmes for examples
Diffstat (limited to 'examples/naval')
-rw-r--r--examples/naval/README14
1 files changed, 14 insertions, 0 deletions
diff --git a/examples/naval/README b/examples/naval/README
new file mode 100644
index 0000000..aa289a2
--- /dev/null
+++ b/examples/naval/README
@@ -0,0 +1,14 @@
+$ naval_
+
+ naval is a simple example of an application that
+ is ported from the docopt example of the same name.
+
+ Unlike the original this one also runs some code and
+ prints messages and it's command line interface was
+ changed slightly to make more sense with established
+ POSIX semantics.
+
+Usage:
+
+ $ pip install --editable .
+ $ naval --help