From 92e1d614e6fde7908a9ed8537811caec306bd276 Mon Sep 17 00:00:00 2001 From: Patrick Oscity Date: Thu, 14 Mar 2013 21:01:02 +0100 Subject: [PATCH] Update README.md --- README.md | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index f8998ac..9539684 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,33 @@ - indentLine ========== -This plugin is used for displaying thin vertical lines at each indentation level for code indented with spaces. -For code indented with tabs, I think there is no need to support it, using :set list lcs=tab:\\|\ (here is a space) can -achieve it. +This plugin is used for displaying thin vertical lines at each indentation level for code indented with spaces. For code indented with tabs I think there is no need to support it, because you can use `:set list lcs=tab:\|\ ` (here is a space). ## Requirements -This plugin takes advantage of newly provided conceal feature in Vim 7.3, so Vim 7.3 with conceal feature is needed. +This plugin takes advantage of the newly provided `conceal` feature in Vim 7.3, so this plugin will not work with lower versions of Vim. ## Installation -To install the plugin just put plugin files in your ~/.vim (linux) or ~/vimfiles (Windows). +To install the plugin just put the plugin files in your `~/.vim` (Linux) or `~/vimfiles` (Windows). -## Setting custom indentLines -You can change the color of indentLines:
-for vim, you can set g:indentLine_color_term in your vimrc, e.g. let g:indentLine_color_term = 239(any color you like),
-for gvim, you can set g:indentLine_color_gui in your vimrc, e.g. let g:indentLine_color_gui = '#A4E57E'(any color you like) +If you use a plugin manager you can put the whole directory into your `~/.vim/bundle/` directory ([Pathogen][pathogen]) or add the line `Bundle 'Yggdroot/indentLine'` to your `.vimrc` ([Vundle][vundle]). -You can change indentLine char by youself.
-change this variable: let g:indentLine_char = 'c'; 'c' can be any ascii character you like, you can also use '¦', '┆'and '│' to display more beautiful lines, -but this only aplies to file whose encoding is utf-8 +## Customization +You can change the color of indentLines: +for Vim, set `g:indentLine_color_term` in your `.vimrc`, e.g. `let g:indentLine_color_term = 239`, +for GVim, set `g:indentLine_color_gui` in your `.vimrc`, e.g. `let g:indentLine_color_gui = '#A4E57E'` -##Self promotion -If you think this script is helpful, follow the GitHub [repository][repository], and don't forget to vote for it on Vim.org! ([vimscript #4354][script]). +You can also change the indentLine char: +for both Vim and GVim, set `let g:indentLine_char = 'c'` where `'c'` can be any ASCII character. You can also use one of `¦`, `┆` or `│` to display more beautiful lines. However, these characters will only work with files whose encoding is UTF-8. + +## Self promotion +If you think this script is helpful, follow the [GitHub repository][repository], and don't forget to vote for it on Vim.org! ([vimscript #4354][script]). + +[pathogen]: https://github.com/tpope/vim-pathogen +[vundle]: https://github.com/gmarik/vundle [repository]: https://github.com/Yggdroot/indentLine [script]: http://www.vim.org/scripts/script.php?script_id=4354 ## Screenshots - +![Screenshot](http://i.imgur.com/KVi0T.jpg)