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-10 06:05:37 +08:00
# Rationale
2013-07-01 03:29:35 +08:00
2013-07-10 06:05:37 +08:00
There's already [powerline][b], why yet another statusline?
2013-07-01 03:29:35 +08:00
2013-07-06 08:15:52 +08:00
* it's 100% vimscript; no python needed.
2013-07-07 21:07:03 +08:00
* it's small. i want the core plugin to be *less than 200 lines* as a rule (specifically adhering to the [open/closed principle][h]).
2013-07-18 13:56:29 +08:00
* despite the small size, it is fully featured and already integrates with: [vim-bufferline][f], [fugitive][d], [unite][i], [ctrlp][j], [minibufexpl][o], [gundo][p], [undotree][q], [nerdtree][r], [tagbar][s], [syntastic][e] and [lawrencium][u].
2013-07-06 08:15:52 +08:00
* it looks good with regular fonts, and provides configuration points so you can use unicode or powerline symbols.
2013-07-03 10:51:10 +08:00
* it's fast to load, taking roughly 1ms. by comparison, powerline needs 60ms on the same machine.
2013-07-06 08:15:52 +08:00
* it's fully customizable; if you know a little `statusline` syntax you can tweak it to your needs.
2013-07-10 06:32:35 +08:00
* it's trivial to write colorschemes; for a minimal theme you need to edit 9 lines of colors. (please send pull requests if you create new themes!)
2013-07-01 03:29:35 +08:00
2013-07-10 06:05:37 +08:00
What about [old powerline][a]?
2013-07-03 21:40:58 +08:00
2013-07-06 08:15:52 +08:00
* the old version still works well, but since it's deprecated new features won't get added
2013-07-11 01:54:25 +08:00
* it uses different font codes, which makes it incompatible with other powerline bindings in the same terminal (e.g. bash, zsh, tmux, etc.)
2013-07-03 21:40:58 +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
* [pathogen][k]
* `git clone https://github.com/bling/vim-airline ~/.vim/bundle/vim-airline`
* [neobundle][l]
* `NeoBundle 'bling/vim-airline'`
* [vundle][m]
* `Bundle 'bling/vim-airline'`
* 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-07-16 11:04:51 +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][t]. Prepatched fonts can be found in the [powerline-fonts][c] 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-07-16 04:19:26 +08:00
Solutions to common problems can be found in the [Wiki ](https://github.com/bling/vim-airline/wiki/FAQ ).
2013-07-15 23:04:06 +08:00
2013-07-10 06:05:37 +08:00
# Screenshots
2013-07-08 10:55:11 +08:00
2013-07-16 04:19:26 +08:00
A full list of screenshots can be found in the [Wiki][n].
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:
* reproduce it with this [minivimrc][g] repository to rule out any configuration conflicts.
* include your version of vim, including patches, and operating system (`:version` will contain this information).
* a link to your vimrc or a gist which shows how you configured the plugin(s)
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.
* this plugin got a lot more popular than i initially expected, if you make changes to the core, please test on as many versions of vim as possible.
2013-07-16 04:19:26 +08:00
* if you submit a theme, please create a screenshot so it can be added to the [Wiki][n].
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-07-15 22:47:48 +08:00
Distributed under the same terms as the Vim license. See `:help license` .
2013-07-02 07:49:40 +08:00
[a]: https://github.com/Lokaltog/vim-powerline
[b]: https://github.com/Lokaltog/powerline
[c]: https://github.com/Lokaltog/powerline-fonts
2013-07-02 09:33:10 +08:00
[d]: https://github.com/tpope/vim-fugitive
[e]: https://github.com/scrooloose/syntastic
[f]: https://github.com/bling/vim-bufferline
2013-07-06 08:15:52 +08:00
[g]: https://github.com/bling/minivimrc
2013-07-07 21:07:03 +08:00
[h]: http://en.wikipedia.org/wiki/Open/closed_principle
[i]: https://github.com/Shougo/unite.vim
[j]: https://github.com/kien/ctrlp.vim
2013-07-08 01:58:15 +08:00
[k]: https://github.com/tpope/vim-pathogen
[l]: https://github.com/Shougo/neobundle.vim
[m]: https://github.com/gmarik/vundle
2013-07-16 04:19:26 +08:00
[n]: https://github.com/bling/vim-airline/wiki/Screenshots
2013-07-10 06:32:35 +08:00
[o]: https://github.com/techlivezheng/vim-plugin-minibufexpl
[p]: https://github.com/sjl/gundo.vim
[q]: https://github.com/mbbill/undotree
[r]: https://github.com/scrooloose/nerdtree
[s]: https://github.com/majutsushi/tagbar
2013-07-13 10:47:56 +08:00
[t]: https://powerline.readthedocs.org/en/latest/fontpatching.html
2013-07-18 13:56:29 +08:00
[u]: https://bitbucket.org/ludovicchabant/vim-lawrencium
