RepoMirrors
/
vim-airline
mirror of https://github.com/vim-airline/vim-airline
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update readme. resolves #109.

This commit is contained in:
Bailey Ling 2013-08-02 08:11:53 -04:00
parent 577e50d788
commit 72852fa665
2 changed files with 19 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -9,18 +9,22 @@ Lean & mean statusline for vim that's light as air.
There's already [powerline][b], why yet another statusline?
* 100% vimscript; no python needed.
* small. i want the core plugin to be *less than 200 lines* as a rule (specifically adhering to the [open/closed principle][h]).
What about [vim-powerline][a]?
* the author has been active developing [powerline][b], which was rewritten in python and expands its capabilities to tools outside of Vim, such as bash, zsh, and tmux.
* [vim-powerline][a] has been deprecated as a result, and no features will be added to it.
* [vim-powerline][a] uses different font codes, so if you want to use it with a [powerline][b] themed tmux (for example), it will not work.
# Features
* tiny core (under 200 lines) and written with extensibility in mind (specifically adhering to the [open/closed principle][h]).
* integrates with a variety of plugins: [vim-bufferline][f], [fugitive][d], [unite][i], [ctrlp][j], [minibufexpl][o], [gundo][p], [undotree][q], [nerdtree][r], [tagbar][s], [syntastic][e] and [lawrencium][u].
* looks good with regular fonts and provides configuration points so you can use unicode or powerline symbols.
* fast to load, taking roughly 1ms. by comparison, powerline needs 60ms on the same machine.
* optimized for speed; it loads 1ms.
* 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).
What about [old powerline][a]?
* the old version still works well, but since it's deprecated new features won't get added.
* it uses different font codes, which makes it incompatible with other powerline bindings in the same terminal (e.g. bash, zsh, tmux, etc.).
# Where did the name come from?
I wrote the initial version on an airplane, and since it's light as air it turned out to be a good name. Thanks for flying vim!

21
doc/airline.txt
View File

@ -3,22 +3,17 @@
==============================================================================
INTRODUCTION *airline*
There's already powerline <https://github.com/Lokaltog/powerline>, why yet
another statusline?
vim-airline is a fast and lightweight alternative to powerline, written
in 100% vimscript with no outside dependencies.
* 100% vimscript; no python needed.
* small. i want the core plugin to be less than 200 lines as a rule.
* integrates with a variety of popular plugins, including:
* fugitve <https://github.com/tpope/vim-fugitive>
* syntastic <https://github.com/scrooloose/syntastic>
* vim-bufferline <https://github.com/bling/vim-bufferline>
* unite <https://github.com/Shougo/unite.vim>
* ctrlp <https://github.com/kien/ctrlp.vim>
* lawrencium <https://bitbucket.org/ludovicchabant/vim-lawrencium>
==============================================================================
FEATURES *airline-features*
* tiny core written with extensibility in mind.
* integrates with many popular plugins.
* looks good with regular fonts, and provides configuration points so you
can use unicode or powerline symbols.
* fast to load, taking roughly 1ms. by comparison, powerline needs 60ms
on the same machine.
* optimized for speed; it loads in 1ms.
* 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