From b1f149ff71ea29e23f7babdde8ccc6b6b6a572ff Mon Sep 17 00:00:00 2001 From: Nate Kane Date: Thu, 30 Dec 2010 09:23:44 +1000 Subject: [PATCH] Tweaked the readme and help file --- README.markdown | 13 ++++++++----- doc/indent_guides.txt | 16 +++++++++------- 2 files changed, 17 insertions(+), 12 deletions(-) diff --git a/README.markdown b/README.markdown index 8f7dfb6..697c063 100644 --- a/README.markdown +++ b/README.markdown @@ -1,15 +1,15 @@ # 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: * 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. -* 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). +* 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). ## Requirements -* vim 7.2+ +* Vim 7.2+ ## Installation 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 The default mapping to toggle the plugin is `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 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: diff --git a/doc/indent_guides.txt b/doc/indent_guides.txt index c016d5b..42f3c0b 100644 --- a/doc/indent_guides.txt +++ b/doc/indent_guides.txt @@ -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* ____ __ __ ______ _ __ @@ -27,15 +27,17 @@ CONTENTS *indent-guides-contents* ============================================================================== 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:~ * 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). * Will highlight indent levels with alternating colors. - * Full support for gvim and basic support for terminal vim. - * Seems to work on Windows gvim 7.3 (haven't done any extensive tests + * 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). ============================================================================== @@ -148,7 +150,7 @@ Alternatively you can manually setup the highlight colors yourself, see Why did I build this plugin?~ * 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. * I wanted to learn me some VimL. @@ -171,7 +173,7 @@ Bug reports, feedback, suggestions etc are welcomed. 7. CHANGELOG *indent-guides-changelog* 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. * Cut down on rgb to hex color conversions by adding a big dictionary of color names and hex codes.