vim-signify/README.md

73 lines
2.1 KiB
Markdown
Raw Normal View History

2013-03-28 05:25:24 -04:00
vim-signify
-----------
2013-03-05 14:07:37 -05:00
2013-10-02 08:27:22 -04:00
![Example:signify in action](https://github.com/mhinz/vim-signify/raw/master/signify.gif)
by Marco Hinz
2013-10-02 08:38:37 -04:00
Twitter: https://twitter.com/_mhinz_
2013-10-02 08:27:22 -04:00
IRC: __mhi^__ (Freenode)
2013-10-02 08:38:37 -04:00
If you use any of my plugins, please star them on github. It's a great way of
getting feedback and gives me the kick to put more time into their development.
If you encounter any bugs or have feature requests, just open an issue report on
Github.
2013-10-02 08:27:22 -04:00
Intro
-----
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
2013-10-02 08:27:22 -04:00
---
2013-03-05 14:07:37 -05:00
Features:
2013-07-29 19:27:05 -04:00
- supports git, mercurial, darcs, bazaar, subversion, cvs, rcs, fossil, accurev,
perforce
2013-07-09 01:28:03 -04:00
- quick jumping between blocks of changed lines
2013-03-05 14:12:24 -05:00
- apart from signs there is also optional line highlighting
2013-03-12 10:05:09 -04:00
- fully configurable through global variables (options and mappings)
2013-03-07 06:56:25 -05:00
- optional preserving of signs from other plugins
- you can toggle the plugin per buffer
- skip certain filetypes and filenames
2013-03-05 14:07:37 -05:00
- good documentation
2013-10-02 08:27:22 -04:00
- depending on your usual workflow you can disable it per default and enable on
demand later
2013-03-05 14:12:24 -05:00
- quick developer response! :-)
2013-03-05 14:07:37 -05:00
2013-03-28 05:25:24 -04:00
What about vim-gitgutter?
-------------------------
2013-03-14 07:51:19 -04:00
2013-10-02 08:27:22 -04:00
Sy provides a superset of gitgutter.
2013-03-14 07:51:19 -04:00
2014-05-04 16:16:07 -04:00
So here is the short answer: The main difference in Sy is its support for version
2013-03-14 07:51:19 -04:00
control systems other than git. Moreover, two of its design goals are speed and
2014-05-04 16:16:07 -04:00
ease of use.
2013-10-02 08:27:22 -04:00
Installation & Documentation
----------------------------
2013-10-02 08:27:22 -04:00
If you have no preferred installation method, I suggest using tpope's
[pathogen](https://github.com/tpope/vim-pathogen). Afterwards installing
2013-10-02 08:33:05 -04:00
vim-signify is as easy as pie:
2013-03-07 07:55:18 -05:00
2013-10-02 08:33:05 -04:00
$ git clone https://github.com/mhinz/vim-signify ~/.vim/bundle/vim-signify
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
:Helptags " rebuilding tags files
:h signify
2013-03-05 14:07:37 -05:00
_NOTE_: The single most important option by far is `g:signify_vcs_list`. Please
read `:h signify-option-vcs_list`.
2013-03-28 05:25:24 -04:00
License
-------
2013-03-05 14:07:37 -05:00
MIT license. Copyright (c) 2013 Marco Hinz.