Skip to content

Commit 21ffc64

Browse files
committed
readme: manual install
1 parent fc306e2 commit 21ffc64

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

readme.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,21 @@ git config --global core.pager "diff-highlight | diff-so-fancy | less --tabs=1,5
2525

2626
## Install
2727

28+
For convenience, the recommended installation is via NPM:
2829
```shell
2930
npm install -g diff-so-fancy
3031
```
3132
This will install and link the `diff-so-fancy` and `diff-highlight` scripts.
3233

34+
### Manual Install
35+
If you want, you can choose to install manually:
36+
37+
* Grab the two scripts (`diff-highlight` and `diff-so-fancy`) via either downloading or cloning the repo.
38+
* Place them in a location that is in your `PATH`.
39+
* Set up the git `core.pager` config, as described above
40+
41+
Note: The `diff-highlight` depenency is an [official git-contrib script](https://github.com/git/git/tree/master/contrib/diff-highlight), duplicated here for convenience.
42+
3343
### GNU sed.
3444
On Mac, install it with Homebrew.
3545
```shell

0 commit comments

Comments
 (0)