branch: externals/diff-hl
commit 8a91d476ef29f235afce5fde5d42c13a97a8a000
Author: Dmitry Gutov <dmi...@gutov.dev>
Commit: Dmitry Gutov <dmi...@gutov.dev>
README updates
Removed the emacs-git-gutter comparison, it was really outdated.
---
README.md | 19 ++++++++-----------
1 file changed, 8 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 5d090f9266..ae05e358c7 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,12 @@
About [](https://github.com/dgutov/diff-hl/actions/workflows/ci.yml)
=====
-`diff-hl-mode` highlights uncommitted changes on the side of the window (area
-also known as the "gutter"), allows you to jump between and revert them
-selectively.
+`diff-hl-mode` highlights uncommitted changes on the side of the window, allows
+you to jump between and revert them selectively.
-In buffers controlled by Git, you can also stage and unstage the changes.
+This feature is also known as "source control gutter indicators".
+
+In buffers controlled by Git, you can stage and unstage the changes.
For the usage instructions and the list of commands, see the Commentary section
inside the file.
@@ -62,7 +63,7 @@ diff-hl-margin-mode
Requirements
=====
-Emacs 25.1+.
+Emacs 26.1+.
Notes
=====
@@ -89,18 +90,14 @@ Notes
* There's no fringe when Emacs is running in the console, but the navigation
and revert commands still work. Consider turning `diff-hl-margin-mode` on,
- to show the indicators in the margin instead.
+ to show the indicators in the margin instead. It also helps avoid the
conflict
+ with Flycheck/Flymake even on graphical frames.
* Frame-local and buffer-local values of `line-spacing` are not supported.
* Fringe width up to 16 works best (because we can't define a bitmap
with width above that number).
-* [emacs-git-gutter](https://github.com/syohex/emacs-git-gutter) shows
- indicators in the margin by default, allows you to customize how the
- indicators look more easily. But it misses some of the other features,
- such as the Dired integration.
-
Integration
=====
