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

Tweaked the readme and help file

Browse Source
This commit is contained in:
Nate Kane 2010-12-30 09:23:44 +10:00
parent 9dbc046d83
commit b1f149ff71
2 changed files with 17 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.markdown
View File

@ -1,15 +1,15 @@
# Indent Guides # Indent Guides
Indent Guides is a plugin for visually displaying indent levels in vim. Indent Guides is a plugin for visually displaying indent levels in Vim.
## Features: ## Features:
* Can detect both tab and space indent styles. * Can detect both tab and space indent styles.
* Automatically inspects your colorscheme and picks appropriate colors (gvim only). * Automatically inspects your colorscheme and picks appropriate colors (gVim only).
* Will highlight indent levels with alternating colors. * Will highlight indent levels with alternating colors.
* Full support for gvim and basic support for terminal vim. * Full support for gVim and basic support for terminal Vim.
* Seems to work on Windows gvim 7.3 (haven't done any extensive tests though). * Seems to work on Windows gVim 7.3 (haven't done any extensive tests though).
## Requirements ## Requirements
* vim 7.2+ * Vim 7.2+
## Installation ## Installation
To install the plugin just copy `autoload`, `plugin`, `doc` directories into your `.vim` directory. To install the plugin just copy `autoload`, `plugin`, `doc` directories into your `.vim` directory.
@ -22,6 +22,9 @@ Alternatively if you have [Pathogen](http://www.vim.org/scripts/script.php?scrip
## Usage ## Usage
The default mapping to toggle the plugin is `<Leader>ig` The default mapping to toggle the plugin is `<Leader>ig`
### gVim
**This plugin should work with gVim out of the box, no configuration needed.** It will automatically inspect your colorscheme and pick appropriate colors.
### Setting custom indent colors ### Setting custom indent colors
Here's an example of how to define custom colors instead of using the ones the plugin automatically generates for you. Add this to your `.vimrc` file: Here's an example of how to define custom colors instead of using the ones the plugin automatically generates for you. Add this to your `.vimrc` file:

16
doc/indent_guides.txt
View File

@ -1,4 +1,4 @@
*indent_guides.txt* A plugin for visually displaying indent levels in vim. *indent_guides.txt* A plugin for visually displaying indent levels in Vim.
*indent-guides* *indent-guides*
____ __ __ ______ _ __ ____ __ __ ______ _ __
@ -27,15 +27,17 @@ CONTENTS *indent-guides-contents*
============================================================================== ==============================================================================
1. INTRODUCTION *indent-guides-introduction* 1. INTRODUCTION *indent-guides-introduction*
Indent Guides is a plugin for visually displaying indent levels in vim. Indent Guides is a plugin for visually displaying indent levels in Vim.
This plugin should work with gVim out of the box, no configuration needed.
Features:~ Features:~
* Can detect both tab and space indent styles. * Can detect both tab and space indent styles.
* Automatically inspects your colorscheme and picks appropriate colors (gvim * Automatically inspects your colorscheme and picks appropriate colors (gVim
only). only).
* Will highlight indent levels with alternating colors. * Will highlight indent levels with alternating colors.
* Full support for gvim and basic support for terminal vim. * Full support for gVim and basic support for terminal Vim.
* Seems to work on Windows gvim 7.3 (haven't done any extensive tests * Seems to work on Windows gVim 7.3 (haven't done any extensive tests
though). though).
============================================================================== ==============================================================================
@ -148,7 +150,7 @@ Alternatively you can manually setup the highlight colors yourself, see
Why did I build this plugin?~ Why did I build this plugin?~
* I believe indent guides make nested code easier to read and understand. * I believe indent guides make nested code easier to read and understand.
* Other editors have them and it's high time vim did. * Other editors have them and it's high time Vim did.
* None of the existing indent guide plugins on the market suited my needs. * None of the existing indent guide plugins on the market suited my needs.
* I wanted to learn me some VimL. * I wanted to learn me some VimL.
@ -171,7 +173,7 @@ Bug reports, feedback, suggestions etc are welcomed.
7. CHANGELOG *indent-guides-changelog* 7. CHANGELOG *indent-guides-changelog*
1.1~ 1.1~
* Added basic support for terminal vim. See |indent-guides-terminal-vim| for * Added basic support for Terminal Vim. See |indent-guides-terminal-vim| for
more information. more information.
* Cut down on rgb to hex color conversions by adding a big dictionary of * Cut down on rgb to hex color conversions by adding a big dictionary of
color names and hex codes. color names and hex codes.