vim-airline-themes/README.md
Christian Brabandt 0ff72ad84c Use the correct variable for defining the theme
document it in the helpfile
2016-09-28 22:11:22 +02:00

59 lines
2.1 KiB
Markdown

# vim-airline-themes
This is the official theme repository for [vim-airline](https://github.com/vim-airline/vim-airline).
# Installation
This plugin follows the standard runtime path structure, and as such it can be installed with a variety of plugin managers:
* [Pathogen][4]
* `git clone https://github.com/vim-airline/vim-airline-themes ~/.vim/bundle/vim-airline-themes`
* Remember to run `:Helptags` to generate help tags
* [NeoBundle][5]
* `NeoBundle 'vim-airline/vim-airline-themes'`
* [Vundle][6]
* `Plugin 'vim-airline/vim-airline-themes'`
* [Plug][7]
* `Plug 'vim-airline/vim-airline-themes'`
* manual
* copy all of the files into your `~/.vim` directory
# Using a Theme
Once installed, use `:AirlineTheme <theme>` to set the theme, e.g. `:AirlineTheme simple`
To set in .vimrc, use `let g:airline_theme='<theme>'`, e.g. `let g:airline_theme='simple'`
# Contribution Guidelines
## New themes
* Pull requests for new themes are welcome. Please be sure to include a screenshot. You can paste an image into issue [#1](https://github.com/vim-airline/vim-airline-themes/issues/1), and then editing the post to reveal the uploaded image URL.
## Modifications to existing themes
* Themes are subjective, so if you are going to make modifications to an existing theme, please expose a configurable variable to allow users to choose how the theme will react.
# Screenshots
Screenshots are in the process of being migrated here. In the meantime you can find screenshots in the existing repository's [Wiki](https://github.com/vim-airline/vim-airline/wiki/Screenshots).
# Maintenance
If you are interested in becoming the official maintainer of this project, please contact [**@bling**][1], [**@chrisbra**][2], or [**@mhartington**][3].
# License
MIT License. Copyright (c) 2013-2016 Bailey Ling & Contributors.
[1]: https://github.com/bling
[2]: https://github.com/chrisbra
[3]: https://github.com/mhartington
[4]: https://github.com/tpope/vim-pathogen
[5]: https://github.com/Shougo/neobundle.vim
[6]: https://github.com/gmarik/vundle
[7]: https://github.com/junegunn/vim-plug