Skip to content

Commit 061349c

Browse files
author
lu0
committed
Update installation steps
1 parent cec11fd commit 061349c

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Table of Contents
1313
---
1414

1515
- [Installation](#installation)
16+
- [Wrapper script](#wrapper-script)
17+
- [Completion rules](#completion-rules)
1618
- [Setup](#setup)
1719
- [Configure your default editor](#configure-your-default-editor)
1820
- [Clone a bare repository](#clone-a-bare-repository)
@@ -27,6 +29,8 @@ Table of Contents
2729

2830
# Installation
2931

32+
## Wrapper script
33+
3034
Clone this repository
3135

3236
```sh
@@ -40,7 +44,25 @@ Link `git-wrapper-script` to your local `PATH`
4044
ln -srf git-worktree-wrapper.sh ~/.local/bin/git-worktree-wrapper
4145
```
4246

43-
Install [my modified fork of complete_alias](https://github.com/lu0/complete-alias).
47+
Add the following to your `~/.bashrc` or `~/.bash_aliases`
48+
49+
```sh
50+
alias git="source git-worktree-wrapper"
51+
```
52+
53+
Restart your terminal or re-run bash
54+
55+
```sh
56+
bash
57+
```
58+
59+
## Completion rules
60+
61+
Check if your current completion rules autocomplete `git` after installing
62+
the wrapper script. Try `git checko` + <kbd>TAB</kbd>
63+
64+
If your git commands are no longer autocompleted, install
65+
[my modified fork of complete_alias](https://github.com/lu0/complete-alias).
4466

4567
```sh
4668
sudo apt install bash-completion

0 commit comments

Comments
 (0)