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

readme: use setext style

Browse Source
This commit is contained in:
Marco Hinz 2013-03-28 10:25:24 +01:00
parent 884faa1fef
commit fbf5a1738e
1 changed files with 20 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,4 +1,5 @@
# vim-signify vim-signify
-----------
Or just: __sy__ Or just: __sy__
@ -24,14 +25,16 @@ Features:
Limits exist only in your mind! Limits exist only in your mind!
## Feedback, please! Feedback, please!
-----------------
If you use any of my plugins, star it on github. This is a great way of getting If you use any of my plugins, star it on github. This is a great way of getting
feedback! Same for issues or feature requests. feedback! Same for issues or feature requests.
Thank you for flying mhi airlines. Get the Vim on! Thank you for flying mhi airlines. Get the Vim on!
## What about vim-gitgutter? What about vim-gitgutter?
-------------------------
To be honest, I don't understand why people always compare plugins like Sy to To be honest, I don't understand why people always compare plugins like Sy to
vim-gitgutter. I understand that it is by far the most known one, but primarily vim-gitgutter. I understand that it is by far the most known one, but primarily
@ -51,7 +54,8 @@ So here is the short answer: The main difference is Sy its support for version
control systems other than git. Moreover, two of its design goals are speed and control systems other than git. Moreover, two of its design goals are speed and
high configurability. high configurability.
## Sign explanation Sign explanation
----------------
`+` `+`
@ -69,7 +73,8 @@ A line was changed. Something was changed, but the amount of lines stayed the sa
A line was changed and one or more of the lines below were deleted. A combination of **!** and **_**. The sign is shown on the same line. A line was changed and one or more of the lines below were deleted. A combination of **!** and **_**. The sign is shown on the same line.
## Longer introduction Longer introduction
-------------------
#### supports several version control systems #### supports several version control systems
@ -144,7 +149,8 @@ let g:signify_skip_filename = { '/home/user/.vimrc': 1 }
You should know by now! You should know by now!
## Installation Installation
------------
I suggest using tpope's pathogen: I suggest using tpope's pathogen:
@ -152,11 +158,13 @@ I suggest using tpope's pathogen:
Afterwards, just clone vim-signify into ~/.vim/bundle/. Afterwards, just clone vim-signify into ~/.vim/bundle/.
## Documentation Documentation
-------------
`:h signify` `:h signify`
## Configuration Configuration
-------------
For more info: `:h signify-options` For more info: `:h signify-options`
@ -205,10 +213,12 @@ let g:signify_cursorhold_normal = 1
let g:signify_cursorhold_insert = 1 let g:signify_cursorhold_insert = 1
``` ```
## Author Author
------
Marco Hinz `<mh.codebro@gmail.com>` Marco Hinz `<mh.codebro@gmail.com>`
## License License
-------
Copyright © 2013 Marco Hinz. Revised BSD license. Copyright © 2013 Marco Hinz. Revised BSD license.