summaryrefslogtreecommitdiff
path: root/oh-my-zsh/plugins/paver/README.md
diff options
context:
space:
mode:
authorAditya <bluenerd@protonmail.com>2023-02-27 20:04:56 +0530
committerAditya <bluenerd@protonmail.com>2023-02-27 20:04:56 +0530
commitedc449275b6c04445f58b108ca0937a87c1e8430 (patch)
tree9fd484d58145b616f29a78857cc0b1c8b1c18f05 /oh-my-zsh/plugins/paver/README.md
parent6f5424ca96c4221ef433f545642669e9c104d0ed (diff)
add zsh
Diffstat (limited to 'oh-my-zsh/plugins/paver/README.md')
-rw-r--r--oh-my-zsh/plugins/paver/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/paver/README.md b/oh-my-zsh/plugins/paver/README.md
new file mode 100644
index 0000000..c38d898
--- /dev/null
+++ b/oh-my-zsh/plugins/paver/README.md
@@ -0,0 +1,12 @@
+# Paver
+
+This plugin adds completion for the `paver` command-line tool of [Paver](https://pythonhosted.org/Paver/).
+
+To use it, add `paver` to the plugins array of your zshrc file:
+```zsh
+plugins=(... paver)
+```
+
+The completion function creates a cache of paver tasks with the name `.paver_tasks`,
+in the current working directory. It regenerates that cache when the `pavement.py`
+changes.