Skip to content

Commit b406871

Browse files
committed
Merge branch 'T99--master'
* T99--master: Revised README with Vundle install and better usage guide
2 parents 018298e + b9657e0 commit b406871

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

README.markdown

+24-4
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,41 @@ Indent Guides is a plugin for visually displaying indent levels in Vim.
1111
* Seems to work on Windows gVim 7.3 (haven't done any extensive tests though).
1212
* Customizable size for indent guides, eg. skinny guides (soft-tabs only).
1313
* Customizable start indent level.
14-
* **NEW:** Highlight support for files with a mixture of tab and space indent styles.
14+
* Highlight support for files with a mixture of tab and space indent styles.
1515

1616
## Requirements
1717
* Vim 7.2+
1818

1919
## Installation
20-
To install the plugin just copy `autoload`, `plugin`, `doc` directories into your `.vim` directory.
20+
To install the plugin copy `autoload`, `plugin`, `doc` directories into your `.vim` directory.
2121

22-
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:
22+
### Pathogen
23+
If you have [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332) installed, clone this repo into a subdirectory of your `.vim/bundle` directory like so:
2324

2425
cd ~/.vim/bundle
2526
git clone git://github.com/nathanaelkane/vim-indent-guides.git
2627

28+
### Vundle
29+
If you have [Vundle](https://github.com/VundleVim/Vundle.vim) installed, add the following line to your `~/.vimrc` in the appropriate spot (see the Vundle.vim README for help):
30+
31+
Plugin 'nathanaelkane/vim-indent-guides'
32+
33+
and then run the following command from inside Vim:
34+
35+
:PluginInstall
36+
2737
## Usage
28-
The default mapping to toggle the plugin is `<Leader>ig`
38+
The default mapping to toggle the plugin is `<Leader>ig`.
39+
40+
You can also use the following commands inside Vim:
41+
42+
:IndentGuidesEnable
43+
:IndentGuidesDisable
44+
:IndentGuidesToggle
45+
46+
If you would like to have indent guides enabled by default, you can add the following to your `~/.vimrc`:
47+
48+
let g:indent_guides_enable_on_vim_startup = 1
2949

3050
### gVim
3151
**This plugin should work with gVim out of the box, no configuration needed.** It will automatically inspect your colorscheme and pick appropriate colors.

0 commit comments

Comments
 (0)