Add stub of README for completion.

oilshell · May 1, 2018 · 73277be5264cb14f95931051d4e54ce082f710ae · 73277be
1 parent 68fcc23
commit 73277be5264cb14f95931051d4e54ce082f710ae
Unified Split

Showing with 15 additions and 0 deletions.

+15 −0 completion/README.md
diff --git a/completion/README.md b/completion/README.md
@@ -0,0 +1,15 @@
+Bash Completion
+---------------
+
+TODO: This directory contains bash completion scripts for Oil developers to
+use.  (Eventually these should be OSH completion scripts!)
+
+Usage:
+
+    source completion/oil-dev-completion.bash
+
+    test/spec.sh sm<TAB>    # should complete to 'smoke'
+    scripts/count.sh a<TAB>  # should complete to 'all'
+
+It also shouldn't clobber what your distro provides.
+