summaryrefslogtreecommitdiffstats
path: root/contrib/autocompletion/README
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/autocompletion/README')
-rw-r--r--contrib/autocompletion/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/contrib/autocompletion/README b/contrib/autocompletion/README
new file mode 100644
index 00000000..1defd219
--- /dev/null
+++ b/contrib/autocompletion/README
@@ -0,0 +1,17 @@
+Bash and Zsh completion
+=======================
+
+From within the gitea root run:
+
+```bash
+source contrib/autocompletion/bash_autocomplete
+```
+
+or for zsh run:
+
+```bash
+source contrib/autocompletion/zsh_autocomplete
+```
+
+These scripts will check if gitea is on the path and if so add autocompletion for `gitea`. Or if not autocompletion will work for `./gitea`.
+If gitea has been installed as a different program pass in the `PROG` environment variable to set the correct program name.