Skip to content

Commit 205e0e0

Browse files
authored
Merge pull request #23 from whiteinge/readme-tweaks
Small README tweaks to emphasize a few points
2 parents 61765d0 + bde9887 commit 205e0e0

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# vim-diffconflicts
22

3-
A better Vimdiff Git (and Mercurial) mergetool
3+
A better Vimdiff mergetool.
44

55
tl;dr:
66

77
* Call `:DiffConflicts` to convert a file containing conflict markers into
88
a two-way diff.
9-
* Install as a Git mergetool to do that automatically. (See
9+
* Install as a Git or Mercurial mergetool to do that automatically. (See
1010
[Installation](#installation) below.)
1111

1212
## Why?
@@ -15,6 +15,13 @@ Watch a demonstration version of this README on YouTube:
1515

1616
[![diffconflicts Video Demonstration](https://img.youtube.com/vi/Pxgl3Wtf78Y/0.jpg)](https://www.youtube.com/watch?v=Pxgl3Wtf78Y)
1717

18+
Contents:
19+
20+
* [Three-Way Diffs are Hard](#three-way-diffs-are-hard)
21+
* [Editing-Conflict-Markers-is-Hard](#editing-conflict-markers-is-hard)
22+
* [Two-Way Diffs are Eas(ier)](#two-way-diffs-are-easier)
23+
* [Conflict-Markers **are** a Two-Way Diff](#conflict-markers-are-a-two-way-diff)
24+
1825
### Three-Way Diffs are Hard
1926

2027
When Git cannot automatically resolve conflicts it writes a file with conflict
@@ -52,16 +59,16 @@ Vimdiff is well suited to two-way diffs:
5259

5360
![](./_utils/vim-diffconflicts.png)
5461

55-
### Conflict-Markers are a Two-Way Diff
62+
### Conflict-Markers **are** a Two-Way Diff
5663

5764
Git does an admirable job of automatically resolving conflicts. We want to
5865
retain all the work and resolve only the things that Git could not. That work
59-
is reflected in the files containing conflict markers, but it is not reflected
60-
in a two-way diff between LOCAL and REMOTE.
66+
_**is**_ reflected in the files containing conflict markers, but it _**is
67+
not**_ reflected in a two-way diff between LOCAL and REMOTE.
6168

62-
Rather than editing the conflict markers directly, it is better to perform a
63-
two-way diff on just the "left" and "right" sides of the conflict markers by
64-
splitting them apart.
69+
Rather than editing the conflict markers directly, it is better to perform
70+
a two-way diff on _**only**_ the "left" and "right" sides of the conflict
71+
markers by splitting them apart.
6572

6673
## Installation
6774

0 commit comments

Comments
 (0)