branch: scratch/add-vdiff
commit cfb90d7bae73f8074a374bfbb7f84d16568db70e
Author: Justin Burkett <[email protected]>
Commit: Justin Burkett <[email protected]>
vdiff-magit: Add note to README
---
README.org | 26 ++++++++++++++++++++++++++
vdiff-magit.el | 3 ---
2 files changed, 26 insertions(+), 3 deletions(-)
diff --git a/README.org b/README.org
index 9fef317..3be33a2 100644
--- a/README.org
+++ b/README.org
@@ -4,6 +4,16 @@
A tool like vimdiff for Emacs
+** Table of Contents :TOC:
+ - [[#vdiff][vdiff]]
+ - [[#introduction][Introduction]]
+ - [[#recent-significant-changes][Recent (Significant) Changes]]
+ - [[#screenshot][Screenshot]]
+ - [[#installation-and-usage][Installation and Usage]]
+ - [[#hydra][Hydra]]
+ - [[#magit-integration][Magit integration]]
+ - [[#further-customization][Further customization]]
+
** Introduction
vdiff is a diff tool for Emacs that is made to behave like vimdiff, meaning
diff
@@ -123,6 +133,22 @@ map. Bind =vdiff-hydra/body= directly to customize this
key binding.
[[file:img/hydra.png]]
+** Magit integration
+
+Loading =vdiff-magit= will pull in functions that will allow vdiff to be used
+with [[https://github.com/magit/magit][magit]]. In order to use these
functions you need to call the vdiff functions
+instead of the magit-ediff ones. Here is a very basic setup which replaces the
+basic ediff key bindings in magit.
+
+Please note that this is a new feature and probably contains some bugs, so use
+it with caution and please report oddities.
+
+#+BEGIN_SRC emacs-lisp
+(require 'vdiff-magit)
+(define-key magit-mode-map "e" 'vdiff-magit-dwim)
+(define-key magit-mode-map "E" 'vdiff-magit-popup)
+#+END_SRC
+
** Further customization
The current customization options and there defaults are
diff --git a/vdiff-magit.el b/vdiff-magit.el
index e2f469e..a9d27fb 100644
--- a/vdiff-magit.el
+++ b/vdiff-magit.el
@@ -110,9 +110,6 @@ tree at the time of stashing."
(?z "Show stash" vdiff-magit-show-stash))
:max-action-columns 2)
-(define-key magit-mode-map "e" 'vdiff-magit-dwim)
-(define-key magit-mode-map "E" 'vdiff-magit-popup)
-
;;;###autoload
(defun vdiff-magit-resolve (file)
"Resolve outstanding conflicts in FILE using vdiff.
