Skip to content

Commit

Permalink
Merge pull request #23 from whiteinge/readme-tweaks
Browse files Browse the repository at this point in the history
Small README tweaks to emphasize a few points
  • Loading branch information
whiteinge authored Dec 28, 2019
2 parents 61765d0 + bde9887 commit 205e0e0
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# vim-diffconflicts

A better Vimdiff Git (and Mercurial) mergetool
A better Vimdiff mergetool.

tl;dr:

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

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

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

Contents:

* [Three-Way Diffs are Hard](#three-way-diffs-are-hard)
* [Editing-Conflict-Markers-is-Hard](#editing-conflict-markers-is-hard)
* [Two-Way Diffs are Eas(ier)](#two-way-diffs-are-easier)
* [Conflict-Markers **are** a Two-Way Diff](#conflict-markers-are-a-two-way-diff)

### Three-Way Diffs are Hard

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

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

### Conflict-Markers are a Two-Way Diff
### Conflict-Markers **are** a Two-Way Diff

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

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

## Installation

Expand Down

0 comments on commit 205e0e0

Please sign in to comment.