vim-airline/README.md

63 lines
2.1 KiB
Markdown
Raw Normal View History

2013-06-30 21:29:35 +02:00
# vim-airline
2013-06-30 20:49:56 +02:00
lean & mean statusline for vim that's light as air
2013-06-30 21:29:35 +02:00
# rationale
there's already [powerline][b], why yet another statusline?
2013-06-30 21:29:35 +02:00
* it's standard vimscript, no python needed
* it's small. i want the entire plugin to be less than 200 lines as a rule
* it gets you 90% of the way there; in addition to all the standard goodies, it integrates with [vim-bufferline][f], [fugitive][d], and [syntastic][e]
* it looks good with regular fonts, and provides configuration points so you can use unicode or powerline symbols
* it's fast to load, taking roughly 1ms. by comparison, powerline needs 60ms on the same machine.
2013-06-30 21:29:35 +02:00
2013-07-03 15:40:58 +02:00
what about [old powerline][a]?
* the old version still works well, but since its deprecated new features won't get added
2013-06-30 21:29:35 +02:00
# why's it called airline?
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-06-30 21:29:35 +02:00
# configuration
`:help airline`
2013-06-30 21:29:35 +02:00
# faq
2013-06-30 21:29:35 +02:00
1. the powerline font symbols are not showing up
* the older deprecated [vim-powerline][a] uses different codes compared to the newer [powerline][b].
* you can grab prepatched fonts at [powerline-fonts][c], or you can manually set the relevant `g:` variables
2. there is a pause when leaving insert mode
2013-07-02 02:35:16 +02:00
* you need to set `ttimeoutlen` to a low number; 50 is recommended
3. the colors don't change properly
2013-07-03 15:40:58 +02:00
* the plugin was developed with `lazyredraw` on, and it appears that this setting has a big impact. please turn it on to see if that fixes it, and file a bug so it can be tracked.
4. you get the error `Unknown function: fugitive#head`
* you are probably using version 1.2, which is very old...download v2 from the [project page][d].
# screenshots
2013-07-01 03:27:15 +02:00
## regular font
![img](regular.png)
## powerline font
![img](powerline.png)
2013-06-30 21:29:35 +02:00
# contributions
2013-06-30 23:10:11 +02:00
contributions and pull requests are welcome.
2013-06-30 21:29:35 +02:00
# license
`:h license`
[a]: https://github.com/Lokaltog/vim-powerline
[b]: https://github.com/Lokaltog/powerline
[c]: https://github.com/Lokaltog/powerline-fonts
[d]: https://github.com/tpope/vim-fugitive
[e]: https://github.com/scrooloose/syntastic
[f]: https://github.com/bling/vim-bufferline