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

Updated the readme

Browse Source
This commit is contained in:
Nate Kane 2010-12-12 00:14:56 +10:00
parent dfa89fd9e2
commit b0a5513065
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.markdown
View File

@ -1,14 +1,18 @@
# Indent Guides # Indent Guides
A Vim plugin for visually displaying indent levels. Indent Guides is a plugin for visually displaying indent levels in vim.
**Status:** almost ready for an official release. ## Features:
* Can detect both tab and space indent styles.
* Automatically inspects your colorscheme and picks appropriate colors.
* Will highlight indent levels with alternating colors.
## Installation ## Installation
Coming soon. To install the plugin just copy `autoload`, `plugin`, `doc` directories into your .vim directory.
## Features 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:
* Can handle both tab and space indent styles
* Automatically inspects your vim colorscheme and picks appropriate colors cd ~/.vim/bundle
git clone git://github.com/nathanaelkane/vim-indent-guides.git
## Usage ## Usage
The default mapping to toggle the plugin is `<Leader>ig` The default mapping to toggle the plugin is `<Leader>ig`
@ -16,6 +20,9 @@ The default mapping to toggle the plugin is `<Leader>ig`
## Help ## Help
`:help indent-guides` `:help indent-guides`
## Screenshot ## Screenshots
<img src="http://dl.dropbox.com/u/1019520/indent_guides_screenshot.png" width="356" height="470" alt="Indent Guides - Screenshot" /> <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" />