]> code.delx.au - gnu-emacs-elpa/blobdiff - README.md
Fix #10
[gnu-emacs-elpa] / README.md
index 78ab74ba5355b8cca2ba3912f4ab0165e4706fd3..de67c58d0f8f62f009a050a050520fb90ed3f3d9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,12 +6,19 @@ allows you to jump between and revert them selectively.
 \r
 For the usage instructions and the list of commands, see the header comment.\r
 \r
-Tested with Git, Mercurial, and Bazaar. May work with other VC backends, too.\r
+Tested with Git, Mercurial, Bazaar and SVN. May work with other VC backends, too.\r
 \r
 Screenshot\r
 =====\r
 \r
-[![screenie](http://i.imgur.com/bC8dBs.png)](http://i.imgur.com/bC8dB.png)\r
+![screenie](screenshot.png)\r
+\r
+Top window: a buffer in this minor mode, bottom window: the corresponding diff.\r
+\r
+Requirements\r
+=====\r
+\r
+Emacs 24+. On OS X, Emacs 24.3 or higher is recommended.\r
 \r
 Notes\r
 =====\r
@@ -21,10 +28,27 @@ Notes
   maybe we can do something similar to `highlight-markup-buffers` with a hidden\r
   buffer containing the unmodified copy.\r
 \r
-* [git-gutter](https://github.com/syohex/emacs-git-gutter) provides the commands\r
-  to show/hide/toggle indicators for the same information, and allows you to\r
-  customize how the indicators look.\r
+* There's no fringe when Emacs is running in the console, but the navigation and\r
+  revert commands still work.\r
+\r
+* Frame-local and buffer-local values of `line-spacing` are not supported.\r
+\r
+* [git-gutter](https://github.com/syohex/emacs-git-gutter) provides interactive\r
+  commands to show/hide/toggle margin indicators for the same information, and\r
+  allows you to customize how the indicators look.\r
+\r
+Integration\r
+=====\r
+\r
+If you're using some package other than `vc` to commit changes, it might\r
+not run `vc-checkin-hook` after commits. In that case, you'll need to\r
+either add `diff-hl-update` to the hook it does run, or advise some\r
+function that's called in the buffer after its state has changed.\r
+\r
+psvn\r
+-----\r
 \r
-* Out of other modes providing similar functionality, `highlight-changes-mode` is the\r
-  closest I could find. Angry Fruit Salad aside, it may be fine for writing\r
-  prose, but I think it's pretty much useless for version-controlled files.\r
+```lisp\r
+(defadvice svn-status-update-modeline (after svn-update-diff-hl activate)\r
+  (diff-hl-update))\r
+```\r