Updated README.md

This commit is contained in:
Christian Brabandt 2017-06-24 17:05:06 +02:00
parent 20a926a1eb
commit 7865fd8ba4
No known key found for this signature in database
GPG Key ID: F3F92DA383FDDE09

View File

@ -1,23 +1,21 @@
# vim-airline-themes
This is the official theme repository for [vim-airline](https://github.com/vim-airline/vim-airline).
This is the official theme repository for [vim-airline][11]
# 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
| Plugin Manager | Install with... |
| ------------- | ------------- |
| [Pathogen][4] | `git clone https://github.com/vim-airline/vim-airline-themes ~/.vim/bundle/vim-airline-themes`<br/>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'` |
| [VAM][8] | `call vam#ActivateAddons([ 'vim-airline-themes' ])` |
| [Dein][9] | `call dein#add('vim-airline/vim-airline-themes')` |
| [minpac][10] | `call minpac#add('vim-airline/vim-airline-themes')` |
| manual | copy all of the files into your `~/.vim` directory |
# Using a Theme
@ -25,12 +23,13 @@ Once installed, use `:AirlineTheme <theme>` to set the theme, e.g. `:AirlineThe
To set in .vimrc, use `let g:airline_theme='<theme>'`, e.g. `let g:airline_theme='simple'`
**Note:** The command `:AirlineTheme` is only available, if you have also cloned and installed the main [vim-airline][11] repository.
# 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.
* 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. Please don't forgot to update the documentation.
## Modifications to existing themes
@ -46,7 +45,7 @@ If you are interested in becoming the official maintainer of this project, pleas
# License
MIT License. Copyright (c) 2013-2016 Bailey Ling & Contributors.
MIT License. Copyright (c) 2013-2017 Bailey Ling & Contributors.
[1]: https://github.com/bling
@ -54,5 +53,9 @@ MIT License. Copyright (c) 2013-2016 Bailey Ling & Contributors.
[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
[6]: https://github.com/VundleVim/Vundle.vim
[7]: https://github.com/junegunn/vim-plug
[8]: https://github.com/MarcWeber/vim-addon-manager
[9]: https://github.com/Shougo/dein.vim
[10]: https://github.com/k-takata/minpac/
[11]: https://github.com/vim-airline/vim-airline