2015-12-27 17:09:26 -05:00
|
|
|
![vim-signify](https://raw.githubusercontent.com/mhinz/vim-signify/master/pictures/signify-logo.png)
|
2013-03-05 14:07:37 -05:00
|
|
|
|
2015-12-27 17:09:26 -05:00
|
|
|
---
|
2013-10-02 08:27:22 -04:00
|
|
|
|
|
|
|
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
|
|
|
|
control system.
|
2013-03-06 17:40:57 -05:00
|
|
|
|
2013-10-02 08:27:22 -04:00
|
|
|
It's __fast__, __easy to use__ and __well documented__.
|
2013-03-05 18:30:30 -05:00
|
|
|
|
2014-12-11 11:28:14 -05:00
|
|
|
_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.
|
|
|
|
|
2015-12-27 17:09:26 -05:00
|
|
|
**Features:**
|
2013-03-05 14:07:37 -05:00
|
|
|
|
2013-07-29 19:27:05 -04:00
|
|
|
- supports git, mercurial, darcs, bazaar, subversion, cvs, rcs, fossil, accurev,
|
|
|
|
perforce
|
2014-10-04 10:20:17 -04:00
|
|
|
- quick jumping between blocks of changed lines ("hunks")
|
2013-03-05 14:12:24 -05:00
|
|
|
- apart from signs there is also optional line highlighting
|
2014-10-04 10:20:17 -04:00
|
|
|
- preserves signs from other plugins
|
2013-03-07 06:56:25 -05:00
|
|
|
- you can toggle the plugin per buffer
|
2013-03-05 14:07:37 -05:00
|
|
|
- good documentation
|
2014-10-04 10:20:17 -04:00
|
|
|
- skip certain filetypes and filenames
|
2013-10-02 08:27:22 -04:00
|
|
|
- depending on your usual workflow you can disable it per default and enable on
|
|
|
|
demand later
|
2014-10-04 10:20:17 -04:00
|
|
|
- fully configurable through global variables (options and mappings)
|
2013-03-05 14:07:37 -05:00
|
|
|
|
2015-12-27 17:09:26 -05:00
|
|
|
## Installation and Documentation
|
2013-04-04 05:14:07 -04:00
|
|
|
|
2015-12-27 17:09:26 -05:00
|
|
|
Use your favorite plugin manager.
|
2013-03-07 07:55:18 -05:00
|
|
|
|
2015-12-27 17:09:26 -05:00
|
|
|
Using [vim-plug](https://github.com/junegunn/vim-plug):
|
|
|
|
|
|
|
|
Plug 'mhinz/vim-signify'
|
2013-03-12 07:25:22 -04:00
|
|
|
|
2013-10-02 08:27:22 -04:00
|
|
|
It works without any configuration, but you might want to look into the
|
|
|
|
documentation for further customization:
|
2013-03-05 14:07:37 -05:00
|
|
|
|
2013-10-02 08:27:22 -04:00
|
|
|
:h signify
|
2013-03-05 14:07:37 -05:00
|
|
|
|
2013-12-01 06:04:58 -05:00
|
|
|
_NOTE_: The single most important option by far is `g:signify_vcs_list`. Please
|
2015-05-21 14:49:55 -04:00
|
|
|
read `:h g:signify_vcs_list`.
|
2013-12-01 06:04:58 -05:00
|
|
|
|
2015-12-27 17:09:26 -05:00
|
|
|
## Demo
|
|
|
|
|
|
|
|
![Example:signify in action](https://raw.githubusercontent.com/mhinz/vim-signify/master/pictures/signify-demo.gif)
|
|
|
|
|
|
|
|
## Author and Feedback
|
|
|
|
|
|
|
|
If you like my plugins, please star them on Github. It's a great way of getting
|
|
|
|
feedback. Same goes for issues reports or feature requests.
|
|
|
|
|
|
|
|
Contact:
|
|
|
|
[Mail](mailto:mh.codebro@gmail.com) |
|
|
|
|
[Twitter](https://twitter.com/_mhinz_) |
|
|
|
|
[Gitter](https://gitter.im/mhinz/mhinz)
|
|
|
|
|
|
|
|
Co-maintainer: [@jamessan](https://github.com/jamessan)
|
2013-03-05 14:07:37 -05:00
|
|
|
|
2015-12-27 17:09:26 -05:00
|
|
|
_Get your Vim on!_
|