Skip to content

Commit 78de3c4

Browse files
Simplify README
1 parent 4f8c953 commit 78de3c4

File tree

2 files changed

+22
-26
lines changed

2 files changed

+22
-26
lines changed

README.md

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,10 @@ Vanilla `git diff` vs `git` and `diff-so-fancy`
1212

1313
Simply copy the `diff-so-fancy` script from the latest release into your `$PATH` and you're done. Alternately to test development features you can clone this repo and then put the `diff-so-fancy` script (symlink will work) into your `$PATH`. The `lib/` directory will need to be kept relative to the core script.
1414

15-
If you are using a ZSH framework like [zgenom](https://github.com/jandamm/zgenom) or [oh-my-zsh](https://ohmyz.sh), refer to [Zsh plugin support for diff-so-fancy](pro-tips.md) for detailed installation instructions.
16-
1715
`diff-so-fancy` is also available from the [NPM registry](https://www.npmjs.com/package/diff-so-fancy), [brew](https://formulae.brew.sh/formula/diff-so-fancy), [Fedora](https://packages.fedoraproject.org/pkgs/diff-so-fancy/diff-so-fancy/), in the [Arch extra repo](https://archlinux.org/packages/extra/any/diff-so-fancy/), and as [ppa:aos for Debian/Ubuntu Linux](https://github.com/aos/dsf-debian).
1816

1917
Issues relating to packaging ("installation does not work", "version is out of date", etc.) should be directed to those packages' repositories/issue trackers where applicable.
2018

21-
**Note:** Windows users may need to install [MinGW](https://sourceforge.net/projects/mingw/files/) or the [Windows subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
22-
2319
## ✨ Usage
2420

2521
### With git
@@ -31,28 +27,7 @@ git config --global core.pager "diff-so-fancy | less --tabs=4 -RF"
3127
git config --global interactive.diffFilter "diff-so-fancy --patch"
3228
```
3329

34-
### Improved colors for the highlighted bits
35-
36-
The default Git colors are not optimal. The colors used for the screenshot above were:
37-
38-
```shell
39-
git config --global color.ui true
40-
41-
git config --global color.diff-highlight.oldNormal "red bold"
42-
git config --global color.diff-highlight.oldHighlight "red bold 52"
43-
git config --global color.diff-highlight.newNormal "green bold"
44-
git config --global color.diff-highlight.newHighlight "green bold 22"
45-
46-
git config --global color.diff.meta "11"
47-
git config --global color.diff.frag "magenta bold"
48-
git config --global color.diff.func "146 bold"
49-
git config --global color.diff.commit "yellow bold"
50-
git config --global color.diff.old "red bold"
51-
git config --global color.diff.new "green bold"
52-
git config --global color.diff.whitespace "red reverse"
53-
```
54-
55-
### With diff
30+
### Manually with diff
5631

5732
Use `-u` with `diff` for unified output, and pipe the output to `diff-so-fancy`:
5833

pro-tips.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,27 @@ application, it may be helpful to configure an alias:
3535

3636
which can then be used as `git patch > changes.patch`.
3737

38+
## Improved colors for the highlighted bits
39+
40+
The default Git colors are not optimal. The colors used for the screenshot were:
41+
42+
```shell
43+
git config --global color.ui true
44+
45+
git config --global color.diff-highlight.oldNormal "red bold"
46+
git config --global color.diff-highlight.oldHighlight "red bold 52"
47+
git config --global color.diff-highlight.newNormal "green bold"
48+
git config --global color.diff-highlight.newHighlight "green bold 22"
49+
50+
git config --global color.diff.meta "11"
51+
git config --global color.diff.frag "magenta bold"
52+
git config --global color.diff.func "146 bold"
53+
git config --global color.diff.commit "yellow bold"
54+
git config --global color.diff.old "red bold"
55+
git config --global color.diff.new "green bold"
56+
git config --global color.diff.whitespace "red reverse"
57+
```
58+
3859
#### Moving around in the diff
3960

4061
You can pre-seed your `less` pager with a search pattern so that you can move

0 commit comments

Comments
 (0)