paver: add README

This commit is contained in:
Marc Cornellà 2019-12-27 01:05:47 +01:00
parent e891fbff9e
commit 4fd2592007
2 changed files with 15 additions and 3 deletions

12
plugins/paver/README.md Normal file
View file

@ -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.

View file

@ -1,7 +1,7 @@
_paver_does_target_list_need_generating () { _paver_does_target_list_need_generating () {
[ ! -f .paver_targets ] && return 0; [ ! -f .paver_targets ] && return 0
[ pavement.py -nt .paver_targets ] && return 0; [ pavement.py -nt .paver_targets ] && return 0
return 1; return 1
} }
_paver () { _paver () {