From c4bdb83f07e8efee940292a42dd286a6263848ca Mon Sep 17 00:00:00 2001 From: Marco Zühlke <mzuehlke@gmail.com> Date: Sun, 28 Oct 2018 11:36:54 +0100 Subject: add readme fot git-flow-avh --- plugins/git-flow-avh/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 plugins/git-flow-avh/README.md (limited to 'plugins/git-flow-avh/README.md') diff --git a/plugins/git-flow-avh/README.md b/plugins/git-flow-avh/README.md new file mode 100644 index 000000000..340ed80d1 --- /dev/null +++ b/plugins/git-flow-avh/README.md @@ -0,0 +1,12 @@ +# 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/). + +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) +``` -- cgit v1.2.3-70-g09d2 From 8f777f30bbb97f27b855bad5585619da499ea7e1 Mon Sep 17 00:00:00 2001 From: Marc Cornellà <marc.cornella@live.com> Date: Sun, 28 Oct 2018 13:37:55 +0100 Subject: add git completion requirements notice --- plugins/git-flow-avh/README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'plugins/git-flow-avh/README.md') 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. -- cgit v1.2.3-70-g09d2