update readme, link to popular colorschemes
This commit is contained in:
Bailey Ling
parent
e84aed79a6
commit
61c95d4103
77
README.md
77
README.md
@ -6,21 +6,21 @@ 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][h]).
|
||||
* integrates with a variety of plugins, including: [vim-bufferline][f], [fugitive][d], [unite][i], [ctrlp][j], [minibufexpl][o], [gundo][p], [undotree][q], [nerdtree][r], [tagbar][s], [syntastic][e] and [lawrencium][u].
|
||||
* tiny core (under 200 lines), written with extensibility in mind (specifically adhering to the [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.
|
||||
* fully customizable; if you know a little `statusline` syntax you can tweak it to your needs.
|
||||
* trivial to write colorschemes; over 10 themes have been contributed.
|
||||
* extensive suite of themes for popular colorschemes including [solarized][23] (dark and light), [tomorrow][24] (all variants), [molokai][25], [jellybeans][26] and others.
|
||||
* supports 7.2 as the minimum Vim version
|
||||
|
||||
# Rationale
|
||||
|
||||
There's already [powerline][b], why yet another statusline?
|
||||
There's already [powerline][2], why yet another statusline?
|
||||
|
||||
* 100% vimscript; no python needed.
|
||||
|
||||
What about [vim-powerline][a]?
|
||||
What about [vim-powerline][1]?
|
||||
|
||||
* 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.
|
||||
@ -34,13 +34,13 @@ I wrote the initial version on an airplane, and since it's light as air it turne
|
||||
|
||||
This plugin follows the standard runtime path structure, and as such it can be installed with a variety of plugin managers:
|
||||
|
||||
* [Pathogen][k]
|
||||
* [Pathogen][11]
|
||||
* `git clone https://github.com/bling/vim-airline ~/.vim/bundle/vim-airline`
|
||||
* [NeoBundle][l]
|
||||
* [NeoBundle][12]
|
||||
* `NeoBundle 'bling/vim-airline'`
|
||||
* [Vundle][m]
|
||||
* [Vundle][13]
|
||||
* `Bundle 'bling/vim-airline'`
|
||||
* [VAM][v]
|
||||
* [VAM][22]
|
||||
* `call vam#ActivateAddons([ 'vim-airline' ])`
|
||||
* manual
|
||||
* copy all of the files into your `~/.vim` directory
|
||||
@ -51,23 +51,23 @@ This plugin follows the standard runtime path structure, and as such it can be i
|
||||
|
||||
# Integrating with powerline fonts
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
Finally, enable them in vim-airline by adding `let g:airline_powerline_fonts = 1` to your vimrc.
|
||||
|
||||
# FAQ
|
||||
|
||||
Solutions to common problems can be found in the [Wiki](https://github.com/bling/vim-airline/wiki/FAQ).
|
||||
Solutions to common problems can be found in the [Wiki][27].
|
||||
|
||||
# Themes/Screenshots
|
||||
|
||||
A full list of screenshots can be found in the [Wiki][n].
|
||||
A full list of screenshots can be found in the [Wiki][14].
|
||||
|
||||
# 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.
|
||||
* reproduce it with this [minivimrc][7] repository to rule out any configuration conflicts.
|
||||
* a link to your vimrc or a gist which shows how you configured the plugin(s).
|
||||
* and so I can reproduce; your `:version` of vim, and the commit of vim-airline you're using.
|
||||
|
||||
@ -78,32 +78,37 @@ Contributions and pull requests are welcome. Please take note of the following
|
||||
* 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.
|
||||
* any changes to the core should be tested against Vim 7.2.
|
||||
* if you submit a theme, please create a screenshot so it can be added to the [Wiki][n].
|
||||
* if you submit a theme, please create a screenshot so it can be added to the [Wiki][14].
|
||||
|
||||
# License
|
||||
|
||||
MIT license. Copyright (c) 2013 Bailey Ling.
|
||||
|
||||
|
||||
[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
|
||||
[g]: https://github.com/bling/minivimrc
|
||||
[h]: http://en.wikipedia.org/wiki/Open/closed_principle
|
||||
[i]: https://github.com/Shougo/unite.vim
|
||||
[j]: https://github.com/kien/ctrlp.vim
|
||||
[k]: https://github.com/tpope/vim-pathogen
|
||||
[l]: https://github.com/Shougo/neobundle.vim
|
||||
[m]: https://github.com/gmarik/vundle
|
||||
[n]: https://github.com/bling/vim-airline/wiki/Screenshots
|
||||
[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
|
||||
[t]: https://powerline.readthedocs.org/en/latest/fontpatching.html
|
||||
[u]: https://bitbucket.org/ludovicchabant/vim-lawrencium
|
||||
[v]: https://github.com/MarcWeber/vim-addon-manager
|
||||
[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
|
||||
|
||||
Loading…
Reference in New Issue
Block a user