From bde9887b721b6ce825883b9d27e35837c842c1c9 Mon Sep 17 00:00:00 2001 From: Seth House Date: Fri, 27 Dec 2019 17:26:27 -0700 Subject: [PATCH] Small README tweaks to emphasize a few points --- README.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c66a1f6..c30b837 100644 --- a/README.md +++ b/README.md @@ -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? @@ -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 @@ -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