2013-07-01 03:29:35 +08:00
# vim-airline
2013-07-01 02:49:56 +08:00
2013-07-10 06:05:37 +08:00
Lean & mean statusline for vim that's light as air.
2013-07-01 03:29:35 +08:00
2013-07-24 11:31:15 +08:00
2013-07-10 06:05:37 +08:00
2013-08-04 04:55:58 +08:00
# Features
2013-08-17 23:12:01 +08:00
* tiny core written with extensibility in mind ([open/closed principle][8]).
2013-08-20 23:43:26 +08:00
* 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], [vim-gitgutter][29], [vim-signify][30], [syntastic][5] and [lawrencium][21].
2013-08-04 04:55:58 +08:00
* looks good with regular fonts and provides configuration points so you can use unicode or powerline symbols.
2013-08-04 09:25:35 +08:00
* optimized for speed; it loads in under a millisecond.
2013-08-04 04:55:58 +08:00
* fully customizable; if you know a little `statusline` syntax you can tweak it to your needs.
2013-08-06 11:34:45 +08:00
* extensive suite of themes for popular colorschemes including [solarized][23] (dark and light), [tomorrow][24] (all variants), [molokai][25], [jellybeans][26] and others; have a look at the [screenshots][14] in the wiki.
2013-08-04 04:55:58 +08:00
* supports 7.2 as the minimum Vim version
2013-08-15 02:29:19 +08:00
# Extensions/Integration
### [ctrlp.vim][10]
### [unite.vim][9]
### [tagbar][19]
### [csv.vim][28]
### [syntastic][5]
### whitespace
2013-08-21 00:57:50 +08:00
### hunks ([vim-gitgutter][29]/[vim-signify][30])
2013-07-10 06:05:37 +08:00
# Rationale
2013-07-01 03:29:35 +08:00
2013-08-05 04:06:24 +08:00
There's already [powerline][2], why yet another statusline?
2013-07-01 03:29:35 +08:00
2013-07-27 01:21:43 +08:00
* 100% vimscript; no python needed.
2013-08-02 20:11:53 +08:00
2013-08-05 04:06:24 +08:00
What about [vim-powerline][1]?
2013-08-02 20:11:53 +08:00
2013-08-02 20:21:47 +08:00
* the author has been active developing powerline, which was rewritten in python and expands its capabilities to tools outside of Vim, such as bash, zsh, and tmux.
* vim-powerline has been deprecated as a result, and no features will be added to it.
* vim-powerline uses different font codes, so if you want to use it with a powerline themed tmux (for example), it will not work.
2013-08-02 20:11:53 +08:00
2013-07-23 05:23:41 +08:00
# Where did the name come from?
2013-07-01 03:29:35 +08:00
2013-07-10 06:05:37 +08:00
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!
2013-07-01 03:29:35 +08:00
2013-07-10 06:05:37 +08:00
# Installation
2013-07-08 01:58:15 +08:00
2013-07-10 06:05:37 +08:00
This plugin follows the standard runtime path structure, and as such it can be installed with a variety of plugin managers:
2013-07-08 01:58:15 +08:00
2013-08-05 04:06:24 +08:00
* [Pathogen][11]
2013-07-08 01:58:15 +08:00
* `git clone https://github.com/bling/vim-airline ~/.vim/bundle/vim-airline`
2013-08-05 04:06:24 +08:00
* [NeoBundle][12]
2013-07-08 01:58:15 +08:00
* `NeoBundle 'bling/vim-airline'`
2013-08-05 04:06:24 +08:00
* [Vundle][13]
2013-07-08 01:58:15 +08:00
* `Bundle 'bling/vim-airline'`
2013-08-05 04:06:24 +08:00
* [VAM][22]
2013-07-26 07:17:32 +08:00
* `call vam#ActivateAddons([ 'vim-airline' ])`
2013-07-08 01:58:15 +08:00
* manual
* copy all of the files into your `~/.vim` directory
2013-07-10 06:05:37 +08:00
# Configuration
2013-07-01 03:29:35 +08:00
2013-07-02 07:49:40 +08:00
`:help airline`
2013-07-01 03:29:35 +08:00
2013-07-13 10:47:56 +08:00
# Integrating with powerline fonts
2013-08-05 04:06:24 +08:00
For the nice looking powerline symbols to appear, you will need to install a patched font. Instructions can be found in the official powerline [documentation][20]. Prepatched fonts can be found in the [powerline-fonts][3] repository.
2013-07-13 10:47:56 +08:00
Finally, enable them in vim-airline by adding `let g:airline_powerline_fonts = 1` to your vimrc.
2013-07-16 04:19:26 +08:00
# FAQ
2013-07-15 23:04:06 +08:00
2013-08-05 04:06:24 +08:00
Solutions to common problems can be found in the [Wiki][27].
2013-07-15 23:04:06 +08:00
2013-07-27 01:21:43 +08:00
# Themes/Screenshots
2013-07-08 10:55:11 +08:00
2013-08-05 04:06:24 +08:00
A full list of screenshots can be found in the [Wiki][14].
2013-07-08 10:55:11 +08:00
2013-07-24 11:00:23 +08:00
# Bugs
Tracking down bugs can take a very long time due to different configurations, versions, and operating systems. To ensure a timely response, please help me out by doing the following:
2013-08-05 04:06:24 +08:00
* reproduce it with this [minivimrc][7] repository to rule out any configuration conflicts.
2013-07-27 01:21:43 +08:00
* a link to your vimrc or a gist which shows how you configured the plugin(s).
2013-08-01 03:37:35 +08:00
* and so I can reproduce; your `:version` of vim, and the commit of vim-airline you're using.
2013-07-24 11:00:23 +08:00
2013-07-10 06:05:37 +08:00
# Contributions
2013-07-01 03:29:35 +08:00
2013-07-10 06:05:37 +08:00
Contributions and pull requests are welcome. Please take note of the following guidelines:
2013-07-09 22:41:37 +08:00
* adhere to the existing style as much as possible; notably, 2 space indents and long-form keywords.
* keep the history clean! squash your branches before you submit a pull request. `pull --rebase` is your friend.
2013-08-04 09:25:35 +08:00
* any changes to the core should be tested against Vim 7.2.
2013-08-05 04:06:24 +08:00
* if you submit a theme, please create a screenshot so it can be added to the [Wiki][14].
2013-07-01 03:29:35 +08:00
2013-07-10 06:05:37 +08:00
# License
2013-07-01 03:29:35 +08:00
2013-08-03 01:56:12 +08:00
MIT license. Copyright (c) 2013 Bailey Ling.
2013-07-15 22:47:48 +08:00
2013-07-02 07:49:40 +08:00
2013-08-08 04:38:50 +08:00
[](https://bitdeli.com/free "Bitdeli Badge")
2013-08-05 04:06:24 +08:00
[1]: https://github.com/Lokaltog/vim-powerline
[2]: https://github.com/Lokaltog/powerline
[3]: https://github.com/Lokaltog/powerline-fonts
[4]: https://github.com/tpope/vim-fugitive
[5]: https://github.com/scrooloose/syntastic
[6]: https://github.com/bling/vim-bufferline
[7]: https://github.com/bling/minivimrc
[8]: http://en.wikipedia.org/wiki/Open/closed_principle
[9]: https://github.com/Shougo/unite.vim
[10]: https://github.com/kien/ctrlp.vim
[11]: https://github.com/tpope/vim-pathogen
[12]: https://github.com/Shougo/neobundle.vim
[13]: https://github.com/gmarik/vundle
[14]: https://github.com/bling/vim-airline/wiki/Screenshots
[15]: https://github.com/techlivezheng/vim-plugin-minibufexpl
[16]: https://github.com/sjl/gundo.vim
[17]: https://github.com/mbbill/undotree
[18]: https://github.com/scrooloose/nerdtree
[19]: https://github.com/majutsushi/tagbar
[20]: https://powerline.readthedocs.org/en/latest/fontpatching.html
[21]: https://bitbucket.org/ludovicchabant/vim-lawrencium
[22]: https://github.com/MarcWeber/vim-addon-manager
[23]: https://github.com/altercation/solarized
[24]: https://github.com/chriskempson/tomorrow-theme
[25]: https://github.com/tomasr/molokai
[26]: https://github.com/nanotech/jellybeans.vim
[27]: https://github.com/bling/vim-airline/wiki/FAQ
2013-08-15 02:29:19 +08:00
[28]: https://github.com/chrisbra/csv.vim
2013-08-19 05:02:33 +08:00
[29]: https://github.com/airblade/vim-gitgutter
2013-08-20 23:43:26 +08:00
[30]: https://github.com/mhinz/vim-signify
