summaryrefslogtreecommitdiff
path: root/start/signify/README.md
diff options
context:
space:
mode:
authorMichael Smith <mikesmiffy128@gmail.com>2022-05-22 22:47:23 +0100
committerMichael Smith <mikesmiffy128@gmail.com>2022-05-22 22:47:23 +0100
commit95aea6b533e71e478d61d18fac71cca116c56a4d (patch)
tree1a1f42f723772258cc54551495826768f374474a /start/signify/README.md
Add all the plugins I currently use
Diffstat (limited to 'start/signify/README.md')
-rw-r--r--start/signify/README.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/start/signify/README.md b/start/signify/README.md
new file mode 100644
index 0000000..c15d0d5
--- /dev/null
+++ b/start/signify/README.md
@@ -0,0 +1,54 @@
+![vim-signify](https://raw.githubusercontent.com/mhinz/vim-signify/master/pictures/signify-logo.png)
+
+---
+
+_Signify (or just Sy) uses the sign column to indicate added, modified and
+removed lines in a file that is managed by a version control system (VCS)._
+
+---
+
+- Supports **git**, **mercurial**, **darcs**, **bazaar**, **subversion**,
+ **cvs**, **rcs**, **fossil**, **accurev**, **perforce**, **tfs**.
+- **Asynchronous** execution of VCS tools for Vim 7.4.1967+ and Neovim.
+- **Preserves signs** from other plugins.
+- Handles **nested repositories** controlled by different VCS.
+- Provides mappings for **navigating hunks** ("blocks of changed lines").
+- Provides an **operator** that acts on hunks.
+- Alternative workflow: Disable the plugin by default and **toggle it per
+ buffer** on demand.
+- Optional **line highlighting**.
+- Optional **skipping of filetypes/filenames**.
+- Optional **stats in the statusline**.
+- **Works out of the box**, but allows fine-grained configuration.
+- **Great documentation** and **handsome maintainers**!
+
+---
+
+_Similar plugin for git: [vim-gitgutter](https://github.com/airblade/vim-gitgutter)_
+
+## Installation
+
+Use your favorite [plugin
+manager](https://github.com/mhinz/vim-galore#managing-plugins), e.g. using
+[vim-plug](https://github.com/junegunn/vim-plug):
+
+ Plug 'mhinz/vim-signify'
+
+## Documentation
+
+1. Understand how the plugin works:
+ [`:h signify-modus-operandi`](https://github.com/mhinz/vim-signify/blob/master/doc/signify.txt#L52)
+1. Spare the plugin some work and read: `:h g:signify_vcs_list`
+
+## Demo
+
+![Example:signify in action](https://raw.githubusercontent.com/mhinz/vim-signify/master/pictures/signify-demo.gif)
+
+## Author and Feedback
+
+If you like this plugin, star it! It's a great way of getting feedback. The same
+goes for reporting issues or feature requests.
+
+Contact: [Twitter](https://twitter.com/_mhinz_)
+
+Co-maintainer: [@jamessan](https://github.com/jamessan)