diff options
| author | Marc Cornellà <marc.cornella@live.com> | 2018-10-28 13:39:50 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-10-28 13:39:50 +0100 |
| commit | 9db3c9455377e15b8125e68a550e751bc5a3203f (patch) | |
| tree | b208f4d00c4bef45a7f3df4366a4b3dd0850741c /plugins/git-flow-avh/README.md | |
| parent | 70246da9cbc96b33256496e501618b9963ac73ee (diff) | |
| parent | b6f629dc1c63c354d1e635f36a0f016554354a86 (diff) | |
| download | zsh-9db3c9455377e15b8125e68a550e751bc5a3203f.tar.gz zsh-9db3c9455377e15b8125e68a550e751bc5a3203f.tar.bz2 zsh-9db3c9455377e15b8125e68a550e751bc5a3203f.zip | |
git-flow-avh: add README (#7360)
Diffstat (limited to 'plugins/git-flow-avh/README.md')
| -rw-r--r-- | plugins/git-flow-avh/README.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/plugins/git-flow-avh/README.md b/plugins/git-flow-avh/README.md new file mode 100644 index 000000000..0768d93ea --- /dev/null +++ b/plugins/git-flow-avh/README.md @@ -0,0 +1,19 @@ +# git-flow (AVH Edition) plugin + +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/). + +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. |