diff options
| author | Marc Cornellà <marc.cornella@live.com> | 2018-10-28 13:37:55 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-10-28 13:37:55 +0100 |
| commit | 8f777f30bbb97f27b855bad5585619da499ea7e1 (patch) | |
| tree | 0bb84237197b985ee99333c2566c49b127ecc044 | |
| parent | c4bdb83f07e8efee940292a42dd286a6263848ca (diff) | |
| download | zsh-8f777f30bbb97f27b855bad5585619da499ea7e1.tar.gz zsh-8f777f30bbb97f27b855bad5585619da499ea7e1.tar.bz2 zsh-8f777f30bbb97f27b855bad5585619da499ea7e1.zip | |
add git completion requirements notice
| -rw-r--r-- | plugins/git-flow-avh/README.md | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/plugins/git-flow-avh/README.md b/plugins/git-flow-avh/README.md index 340ed80d1..0768d93ea 100644 --- a/plugins/git-flow-avh/README.md +++ b/plugins/git-flow-avh/README.md @@ -3,10 +3,17 @@ This plugin adds completion for the [git-flow (AVH Edition)](https://github.com/petervanderdoes/gitflow-avh). The AVH Edition of the git extensions that provides high-level repository operations for [Vincent Driessen's branching model](https://nvie.com/posts/a-successful-git-branching-model/). -The git-flow tool has to be [installed](https://github.com/petervanderdoes/gitflow-avh#installing-git-flow) separately. - To use it, add `git-flow-avh` to the plugins array in your zshrc file: ```zsh plugins=(... git-flow-avh) ``` + +## Requirements + +1. The git-flow tool has to be [installed](https://github.com/petervanderdoes/gitflow-avh#installing-git-flow) + separately. + +2. You have to use zsh's git completion instead of the git project's git completion. This is typically + done by default so you don't need to do anything else. If you installed git with Homebrew you + might have to uninstall the git completion it's bundled with. |