[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] scratch/add-vdiff 9be4fe3 066/258: Update install instructions in
From: |
Justin Burkett |
Subject: |
[elpa] scratch/add-vdiff 9be4fe3 066/258: Update install instructions in README |
Date: |
Wed, 17 May 2017 08:13:24 -0400 (EDT) |
branch: scratch/add-vdiff
commit 9be4fe324083744b7b6f69fcf41186db108fe007
Author: justbur <address@hidden>
Commit: justbur <address@hidden>
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.
- [elpa] scratch/add-vdiff 466b852 173/258: Fix subtraction overlay addition, (continued)
- [elpa] scratch/add-vdiff 466b852 173/258: Fix subtraction overlay addition, Justin Burkett, 2017/05/17
- [elpa] scratch/add-vdiff f3b6cec 179/258: Center on start, Justin Burkett, 2017/05/17
- [elpa] scratch/add-vdiff 667a7e4 144/258: Generalize data structures to prepare for diff3, Justin Burkett, 2017/05/17
- [elpa] scratch/add-vdiff 059d288 208/258: Update gitignore, Justin Burkett, 2017/05/17
- [elpa] scratch/add-vdiff cfad650 207/258: Provide missing function for emacs-nox users, Justin Burkett, 2017/05/17
- [elpa] scratch/add-vdiff e567468 221/258: vdiff-magit: Port show-working-tree, Justin Burkett, 2017/05/17
- [elpa] scratch/add-vdiff 30b0f9c 213/258: Add vdiff-magit.el with two functions, Justin Burkett, 2017/05/17
- [elpa] scratch/add-vdiff 64430c3 215/258: Cleanup merge, Justin Burkett, 2017/05/17
- [elpa] scratch/add-vdiff 19f4616 217/258: vdiff-magit: Port compare and show-commit, Justin Burkett, 2017/05/17
- [elpa] scratch/add-vdiff a81d62a 240/258: README: Update recent changes, Justin Burkett, 2017/05/17
- [elpa] scratch/add-vdiff 9be4fe3 066/258: Update install instructions in README,
Justin Burkett <=
- [elpa] scratch/add-vdiff eda4b1b 204/258: Force update of window-start in manual calls to scroll func, Justin Burkett, 2017/05/17
- [elpa] scratch/add-vdiff 7d60015 201/258: Add some doctrings, Justin Burkett, 2017/05/17
- [elpa] scratch/add-vdiff 3037be6 222/258: vdiff-magit: Cleanup references in dwim, Justin Burkett, 2017/05/17
- [elpa] scratch/add-vdiff 615e7bd 228/258: vdiff-magit: Fix killing of buffers in stage, Justin Burkett, 2017/05/17
- [elpa] scratch/add-vdiff a040a4b 246/258: vdiff: Add vdiff-merge-conflict, Justin Burkett, 2017/05/17
- [elpa] scratch/add-vdiff 7fbb20e 205/258: Nil temp-session after using it, Justin Burkett, 2017/05/17
- [elpa] scratch/add-vdiff 048d544 198/258: Pass session explicitly from refresh sentinel, Justin Burkett, 2017/05/17
- [elpa] scratch/add-vdiff ed25084 224/258: vdiff-magit: Fix some strings, Justin Burkett, 2017/05/17
- [elpa] scratch/add-vdiff 432534d 230/258: vdiff-magit: Don't use vdiff-magit-resolve yet, Justin Burkett, 2017/05/17
- [elpa] scratch/add-vdiff 1d79425 235/258: vdiff-magit: Cleanup header, Justin Burkett, 2017/05/17