Skip to content

Commit

Permalink
Add instructions for BASH completion installation
Browse files Browse the repository at this point in the history
Git BASH completion always has to be installed along with Elegant Git
completion in order to have the last completion working.
  • Loading branch information
extsoft committed Oct 7, 2019
1 parent a708187 commit 83d2e81
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,14 @@ Git's commands in order to get Elegant Git working by default.
Run `curl https://raw.githubusercontent.com/bees-hive/elegant-git/master/install.bash | $(which bash)`
and follow the provided instructions to install the tool. `${HOME}/.elegant-git` directory will host
all required files. That's why if you want to remove installation, you need to remove this directory
only (`rm -r ${HOME}/.elegant-git`).
only (`rm -r ${HOME}/.elegant-git`).

Elegant Git's BASH completion does not work without regular Git BASH completion. If you don't have
it, please follow <https://github.com/bobthecow/git-flow-completion/wiki/Install-Bash-git-completion>
in addition to Elegant Git's configuration.

# Homebrew installation
On macOS, you can install [Homebrew](https://brew.sh/) if you haven't already, then run
`brew install bees-hive/hive/elegant-git`. To find out more please visit
<https://github.com/bees-hive/homebrew-hive>.
`brew install git` (we must install Git with Homebrew in order to have a working BASH completion)
and `brew install bees-hive/hive/elegant-git` (please visit
<https://github.com/bees-hive/homebrew-hive> if you need details).

0 comments on commit 83d2e81

Please sign in to comment.