From 5d92aaecaa33cb2b427fabd4b6fd9ecc5446c53d Mon Sep 17 00:00:00 2001 From: Bailey Ling Date: Sat, 10 Aug 2013 23:22:42 +0000 Subject: [PATCH] update documentation --- README.md | 2 +- doc/airline.txt | 31 +++++++++++++++++++------------ 2 files changed, 20 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 5442dd02..eb06d81a 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Lean & mean statusline for vim that's light as air. # Features -* tiny core (under 200 lines), written with extensibility in mind (specifically adhering to the [open/closed principle][8]). +* tiny core (under 200 lines), written with extensibility in mind ([open/closed principle][8]). * integrates with a variety of plugins, including: [vim-bufferline][6], [fugitive][4], [unite][9], [ctrlp][10], [minibufexpl][15], [gundo][16], [undotree][17], [nerdtree][18], [tagbar][19], [syntastic][5] and [lawrencium][21]. * looks good with regular fonts and provides configuration points so you can use unicode or powerline symbols. * optimized for speed; it loads in under a millisecond. diff --git a/doc/airline.txt b/doc/airline.txt index f6a4a447..42da6786 100644 --- a/doc/airline.txt +++ b/doc/airline.txt @@ -1,5 +1,10 @@ *airline.txt* Lean and mean statusline that's light as air - + _ _ _ _ ~ + __ _(_)_ __ ___ __ _(_)_ __| (_)_ __ ___ ~ + \ \ / / | '_ ` _ \ _____ / _` | | '__| | | '_ \ / _ \ ~ + \ V /| | | | | | |_____| (_| | | | | | | | | | __/ ~ + \_/ |_|_| |_| |_| \__,_|_|_| |_|_|_| |_|\___| ~ + ~ ============================================================================== INTRODUCTION *airline* @@ -16,8 +21,7 @@ FEATURES *airline-features* * optimized for speed; it loads in under a millisecond. * fully customizable; if you know a little |statusline| syntax you can tweak it to your needs. -* trivial to write colorschemes; for a minimal theme you need to edit - 9 lines of colors. (please send pull requests) +* extremely easy to write themes. ============================================================================== NAME *airline-name* @@ -232,38 +236,41 @@ highlight groups. TROUBLESHOOTING *airline-troubleshooting* Q. There are no colors. - A. You need to set up your terminal correctly. For more details, see -. Alternatively, if you want to -bypass the automatic detection of terminal colors, you can force Vim into 256 -colors with this: + . Alternatively, if you want + to bypass the automatic detection of terminal colors, you can force Vim + into 256 color mode with this: > set t_Co=256 < Q. The statusline does not appear until I create a split. - A. This is the default setting of |laststatus|. If you want it to appear all -the time, add the following to your vimrc: + the time, add the following to your vimrc: > set laststatus=2 < Q. Powerline symbols are not showing up. - A. First, you must install patched powerline fonts. Second, you must enable -unicode in vim. + unicode in vim. > set encoding=utf-8 < Q. There is a pause when leaving insert mode. - A. Add the following to your vimrc. > set ttimeoutlen=50 < +Q. The colors look a little off for some themes. +A. Certain themes are derived from the active colorscheme by extracting colors + from predefined highlight groups. These airline themes will look good for + their intended matching colorschemes, but will be hit or miss when loaded + with other colorschemes. + + Solutions to other common problems can be found in the Wiki: