Document the reason for the name gitgutter

This commit is contained in:
Andy Stewart
2020-04-23 09:02:22 +01:00
parent 3599736179
commit 9e99a78271
2 changed files with 8 additions and 3 deletions

View File

@@ -1,9 +1,11 @@
## vim-gitgutter ## vim-gitgutter
A Vim plugin which shows a git diff in the 'gutter' (sign column). It shows which lines have been added, modified, or removed. You can also preview, stage, and undo individual hunks; and stage partial hunks. The plugin also provides a hunk text object. A Vim plugin which shows a git diff in the sign column. It shows which lines have been added, modified, or removed. You can also preview, stage, and undo individual hunks; and stage partial hunks. The plugin also provides a hunk text object.
The signs are always up to date and the plugin never saves your buffer. The signs are always up to date and the plugin never saves your buffer.
The name "gitgutter" comes from the Sublime Text 3 plugin which inspired this one in 2013.
Features: Features:
* Shows signs for added, modified, and removed lines. * Shows signs for added, modified, and removed lines.

View File

@@ -1,7 +1,7 @@
*gitgutter.txt* A Vim plugin which shows a git diff in the gutter. *gitgutter.txt* A Vim plugin which shows a git diff in the gutter.
Vim Git Gutter Vim GitGutter
Author: Andy Stewart <https://airbladesoftware.com/> Author: Andy Stewart <https://airbladesoftware.com/>
@@ -27,13 +27,16 @@ CONTENTS *gitgutter*
=============================================================================== ===============================================================================
INTRODUCTION *gitgutter-introduction* INTRODUCTION *gitgutter-introduction*
GitGutter is a Vim plugin which shows a git diff in the 'gutter' (sign column). GitGutter is a Vim plugin which shows a git diff in the sign column.
It shows which lines have been added, modified, or removed. You can also It shows which lines have been added, modified, or removed. You can also
preview, stage, and undo individual hunks. The plugin also provides a hunk preview, stage, and undo individual hunks. The plugin also provides a hunk
text object. text object.
The signs are always up to date and the plugin never saves your buffer. The signs are always up to date and the plugin never saves your buffer.
The name "gitgutter" comes from the Sublime Text 3 plugin which inspired this
one in 2013.
=============================================================================== ===============================================================================
INSTALLATION *gitgutter-installation* INSTALLATION *gitgutter-installation*