branch: scratch/add-vdiff
commit 9be4fe324083744b7b6f69fcf41186db108fe007
Author: justbur <[email protected]>
Commit: justbur <[email protected]>
Update install instructions in README
---
README.org | 30 ++++++++++++++++++++----------
1 file changed, 20 insertions(+), 10 deletions(-)
diff --git a/README.org b/README.org
index f407a8f..7e970c1 100644
--- a/README.org
+++ b/README.org
@@ -24,20 +24,21 @@ suggestions are very welcome.
[[./img/leuven.png]]
** Installation and Usage
-
-It will be on MELPA eventually. For now, you have to clone this repository and
-modify =load-path=. Here's an example =use-package= declaration.
+
+vdiff was recently added to MELPA, which is the recommended way to install it
+and keep it up to date. To install it you may do =M-x package-install RET vdiff
+RET=.
+
+After installing you can bind the commands to your preferred key prefix like
this
#+BEGIN_SRC emacs-lisp
-(use-package vdiff
- :load-path "path/to/vdiff"
- :commands (vdiff-buffers vdiff-files)
- :config
- (define-key vdiff-mode-map (kbd "C-c") vdiff-mode-prefix-map))
+(require 'vdiff)
+(define-key vdiff-mode-map (kbd "C-c") vdiff-mode-prefix-map)
#+END_SRC
-The last line puts the main vdiff commands under the =C-c= prefix. With this
-declaration the key bindings in vdiff buffers are
+which will bind most of the commands under the =C-c= prefix when vdiff-mode is
+active. Of course you can pick whatever prefix you prefer. With the =C-c=
prefix
+the commands would be
| Key | Command | Description
|
|---------+---------------------------------+----------------------------------------------------|
@@ -54,6 +55,15 @@ declaration the key bindings in vdiff buffers are
| =C-c q= | =vdiff-quit= | Quit vdiff
|
| =C-l= | =vdiff-sync-and-center= | Recenter both buffers at current
line |
+Evil-mode users might prefer something like the following to use =,= as a
prefix
+in normal state.
+
+#+BEGIN_SRC emacs-lisp
+(require 'vdiff)
+(require 'evil)
+(evil-define-key 'normal vdiff-mode-map "," vdiff-mode-prefix-map)
+#+END_SRC
+
To start vdiff, use either =vdiff-files= to select two files or =vdiff-buffers=
to select two open buffers.
