[elpa] scratch/add-vdiff 1965a5a 3/4: Rewrite introduction for people unfamiliar with vimdiff

[Justin Burkett]

branch: scratch/add-vdiff
commit 1965a5ad25749c0102018c420e4abcfd7567b0bd
Author: Justin Burkett <address@hidden>
Commit: Justin Burkett <address@hidden>

    Rewrite introduction for people unfamiliar with vimdiff
---
 README.org | 36 +++++++++++++++++++-----------------
 vdiff.el   | 36 +++++++++++++++++-------------------
 2 files changed, 36 insertions(+), 36 deletions(-)

diff --git a/README.org b/README.org
index 8fc21a2..42e2463 100644
--- a/README.org
+++ b/README.org
@@ -16,23 +16,25 @@ A tool like vimdiff for Emacs
 
 ** Introduction
 
-vdiff is a diff tool for Emacs that is made to behave like vimdiff, meaning 
diff
-information is displayed in buffers as you edit them. There are commands for
-cycling through the hunks detected by =diff= and applying changes from one
-buffer to the other. The main features are
-
-  1. Synchronized scrolling of the buffers with lines matching between the two
-  2. Commands to transmit (send/receive) hunks between buffers
-  3. Automatic folding of lines that are unchanged in both buffers
-  4. Commands to jump easily between hunks
-  5. Everything done through overlays, meaning vdiff doesn't alter the actual
-     text in the buffer (unless you are transmit changes of course)
-  6. Unlike ediff, remain in buffers instead of having to use a third "control
-     buffer"
-  7. Cool hydra (see below)
-
-vdiff has not been extensively tested yet, so please report any issues you
-find. Contributions and suggestions are very welcome.
+vdiff compares two or three buffers on the basis of the output from the diff
+tool. The buffers are kept synchronized so that as you move through one of the
+buffers the top of the active buffer aligns with the corresponding top of the
+other buffer(s). This is similar to how ediff works, but in ediff you use a
+third "control buffer" to move through the diffed buffers. The key difference 
is
+that in vdiff you are meant to actively edit one of the buffers and the display
+will update automatically for the other buffer. Similar to ediff, vdiff 
provides
+commands to "send" and "receive" hunks from one buffer to the other as well as
+commands to traverse the diff hunks, which are useful if you are trying to 
merge
+changes. In contrast to ediff, vdiff also provides folding capabilities to fold
+sections of the buffers that don't contain changes. This folding occurs
+automatically. Finally, you are encouraged to bind a key to `vdiff-hydra/body',
+which will use hydra.el (in ELPA) to create a convenient transient keymap
+containing most of the useful vdiff commands.
+
+This functionality is all inspired by (but not equivalent to) the vimdiff tool
+from vim.
+
+Contributions and suggestions are very welcome.
 
 ** Recent (Significant) Changes
    - [2017-02-01] Added magit integration functions in =vdiff-magit.el=. See 
[[#magit-integration][Magit integration]].
diff --git a/vdiff.el b/vdiff.el
index ac2887a..ba26feb 100644
--- a/vdiff.el
+++ b/vdiff.el
@@ -31,25 +31,23 @@
 
 ;; A tool like vimdiff for Emacs
 
-;; * Introduction
-
-;; vdiff is a diff tool for Emacs that is made to behave like vimdiff, meaning
-;; diff information is displayed in buffers as you edit them. There are 
commands
-;; for cycling through the hunks detected by =diff= and applying changes from
-;; one buffer to the other. The main features are
-
-;;   1. Synchronized scrolling of the buffers with lines matching between the
-;;      two
-;;   2. Commands to transmit (send/receive) changes between buffers
-;;   3. Automatic folding of lines that are unchanged in both buffers
-;;   4. Commands to jump easily between hunks
-;;   5. Everything done through overlays, meaning vdiff doesn't alter the 
actual
-;;      text in the buffer (unless you are transmit changes of course)
-;;   6. Unlike ediff, remain in buffers instead of having to use a third 
"control
-;;      buffer"
-;;   7. Cool hydra
-
-;; Contributions and suggestions are very welcome.
+;; vdiff compares two or three buffers on the basis of the output from the diff
+;; tool. The buffers are kept synchronized so that as you move through one of
+;; the buffers the top of the active buffer aligns with the corresponding top 
of
+;; the other buffer(s). This is similar to how ediff works, but in ediff you 
use
+;; a third "control buffer" to move through the diffed buffers. The key
+;; difference is that in vdiff you are meant to actively edit one of the 
buffers
+;; and the display will update automatically for the other buffer. Similar to
+;; ediff, vdiff provides commands to "send" and "receive" hunks from one buffer
+;; to the other as well as commands to traverse the diff hunks, which are 
useful
+;; if you are trying to merge changes. In contrast to ediff, vdiff also 
provides
+;; folding capabilities to fold sections of the buffers that don't contain
+;; changes. This folding occurs automatically. Finally, you are encouraged to
+;; bind a key to `vdiff-hydra/body', which will use hydra.el (in ELPA) to 
create
+;; a convenient transient keymap containing most of the useful vdiff commands.
+
+;; This functionality is all inspired by (but not equivalent to) the vimdiff
+;; tool from vim.
 
 ;; See https://github.com/justbur/emacs-vdiff for more information