vim/vim-signify
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

README: slight polishing

Browse Source
This commit is contained in:
Marco Hinz 2016-11-27 14:36:47 +01:00
parent a7e3219de8
commit b78d545c30
No known key found for this signature in database
GPG Key ID: 1C980A1B657B4A4F
1 changed files with 18 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -3,17 +3,12 @@
--- ---
Signify (or just Sy) is a quite unobtrusive plugin. It uses signs to indicate Signify (or just Sy) is a quite unobtrusive plugin. It uses signs to indicate
added, modified and removed lines based on data of an underlying version added, modified and removed lines based on data of an underlying version control
control system. system.
It's __fast__, __easy to use__ and __well documented__. It's __fast__, __easy to use__ and __well documented__.
_NOTE:_ If git is the only version control system you use, I suggest having a ---
look at [vim-gitgutter](https://github.com/airblade/vim-gitgutter). It provides
more git-specific features that would be unfeasible for Sy, since it only
implements features that work for _all_ supported VCS.
**Features:**
- supports git, mercurial, darcs, bazaar, subversion, cvs, rcs, fossil, accurev, - supports git, mercurial, darcs, bazaar, subversion, cvs, rcs, fossil, accurev,
perforce, tfs perforce, tfs
@ -27,11 +22,18 @@ implements features that work for _all_ supported VCS.
demand later demand later
- fully configurable through global variables (options and mappings) - fully configurable through global variables (options and mappings)
---
_If git is the only version control system you use, I suggest having a look at
[vim-gitgutter](https://github.com/airblade/vim-gitgutter). It provides more
git-specific features that would be unfeasible for Sy, since it only implements
features that work for _all_ supported VCS._
## Installation and Documentation ## Installation and Documentation
Use your favorite plugin manager. Use your favorite [plugin
manager](https://github.com/mhinz/vim-galore#managing-plugins), e.g. using
Using [vim-plug](https://github.com/junegunn/vim-plug): [vim-plug](https://github.com/junegunn/vim-plug):
Plug 'mhinz/vim-signify' Plug 'mhinz/vim-signify'
@ -40,8 +42,8 @@ documentation for further customization:
:h signify :h signify
_NOTE_: The single most important option by far is `g:signify_vcs_list`. Please _The single most important option by far is `g:signify_vcs_list`. Please read
read `:h g:signify_vcs_list`. `:h g:signify_vcs_list`._
## Demo ## Demo
@ -49,14 +51,9 @@ read `:h g:signify_vcs_list`.
## Author and Feedback ## Author and Feedback
If you like my plugins, please star them on Github. It's a great way of getting If you like this plugin, star it! It's a great way of getting feedback. The same
feedback. Same goes for issues reports or feature requests. goes for reporting issues or feature requests.
Contact: Contact: [Twitter](https://twitter.com/_mhinz_)
[Mail](mailto:mh.codebro@gmail.com) |
[Twitter](https://twitter.com/_mhinz_) |
[Gitter](https://gitter.im/mhinz/mhinz)
Co-maintainer: [@jamessan](https://github.com/jamessan) Co-maintainer: [@jamessan](https://github.com/jamessan)
_Get your Vim on!_