vim-indent-guides/README.markdown

29 lines
1.3 KiB
Markdown
Raw Normal View History

2010-12-07 08:35:02 -05:00
# Indent Guides
2010-12-11 09:14:56 -05:00
Indent Guides is a plugin for visually displaying indent levels in vim.
2010-12-07 08:35:02 -05:00
2010-12-11 09:14:56 -05:00
## Features:
* Can detect both tab and space indent styles.
* Automatically inspects your colorscheme and picks appropriate colors.
* Will highlight indent levels with alternating colors.
2010-12-07 08:47:48 -05:00
2010-12-07 08:45:07 -05:00
## Installation
2010-12-11 09:14:56 -05:00
To install the plugin just copy `autoload`, `plugin`, `doc` directories into your .vim directory.
2010-12-07 08:35:02 -05:00
2010-12-11 09:14:56 -05:00
Alternatively if you have [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332) installed, just clone this repo into a subdirectory of your .vim/bundle directory like so:
cd ~/.vim/bundle
git clone git://github.com/nathanaelkane/vim-indent-guides.git
2010-12-07 08:45:07 -05:00
## Usage
The default mapping to toggle the plugin is `<Leader>ig`
2010-12-07 08:35:02 -05:00
2010-12-07 08:45:07 -05:00
## Help
`:help indent-guides`
2010-12-11 09:14:56 -05:00
## Screenshots
<img src="https://dl.dropbox.com/u/1019520/vim-indent-guides/rdark.png" width="400" height="400" alt="Indent Guides screenshot: rdark" />
<img src="https://dl.dropbox.com/u/1019520/vim-indent-guides/bclear.png" width="400" height="400" alt="Indent Guides screenshot: bclear" />
<img src="https://dl.dropbox.com/u/1019520/vim-indent-guides/clarity.png" width="400" height="400" alt="Indent Guides screenshot: clarity" />
<img src="https://dl.dropbox.com/u/1019520/vim-indent-guides/moss.png" width="400" height="400" alt="Indent Guides screenshot: moss" />
2010-12-07 08:35:02 -05:00