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

Added draft verison of plugin help file

Browse Source
This commit is contained in:
Nate Kane 2010-12-05 17:18:59 +10:00
parent 515cc0c5ca
commit b8c4e492b9
1 changed files with 76 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
docs/indent-guides.txt Normal file
View File

@ -0,0 +1,76 @@
*indent-guides.txt* A plugin for visually displaying indent levels in Vim.
*indent-guides*
____ __ __ ______ _ __
/ _/____ ____/ /___ ____ / /_ / ____/__ __(_)____/ /___ _____
/ / / __ \/ __ // _ \/ __ \/ __/ / / __ / / / / // __ // _ \/ ___/
_/ / / / / / /_/ // __/ / / / /_ / /_/ // /_/ / // /_/ // __(__ )
/___//_/ /_/\__,_/ \___/_/ /_/\__/ \____/ \__,_/_/ \__,_/ \___/____/
A plugin for visually displaying indent levels in Vim.
Author: Nate Kane <nathanaelkane AT gmail DOT com>
Version: 1.0
Last Change: 05 Dec 2010
==============================================================================
CONTENTS *indent-guides-contents*
1. Commands.................................. |indent-guides-commands|
2. Options................................... |indent-guides-options|
3. Changelog................................. |indent-guides-changelog|
4. License................................... |indent-guides-license|
==============================================================================
COMMANDS *indent-guides-commands*
:IndentGuidesEnable *:IndentGuidesEnable*
Enables the indent guides for the current buffer.
:IndentGuidesDisable *:IndentGuidesDisable*
Disables the indent guides for the current buffer.
==============================================================================
OPTIONS *indent-guides-options*
*'IndentGuides_indent_levels'*
Use this option to control how many indent levels to display guides for:
>
let g:IndentGuides_indent_levels=20
<
==============================================================================
CHANGELOG *indent-guides-changelog*
1.0~
* First public version.
==============================================================================
LICENSE *indent-guides-license*
The MIT Licence
http://www.opensource.org/licenses/mit-license.php
Copyright (c) 2010 Nate Kane
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
vim:tw=78:ts=2:ft=help:norl: