vim/vim-airline
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update docs, update link to faq in the wiki

Browse Source
This commit is contained in:
Bailey Ling 2013-07-15 20:19:26 +00:00
parent a6895e2754
commit 294f07d975
2 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -56,13 +56,13 @@ If you encounter a bug, please do the following:
* specify your version and patch level, as well as operating system (found with `:version`).
* a link to a gist or your vimrc where it can be reproduced.
# FAQ/Troubleshooting
# FAQ
Solutions to common problems can be found in the [Wiki](https://github.com/bling/vim-airline/wiki/FAQ-Troubleshooting).
Solutions to common problems can be found in the [Wiki](https://github.com/bling/vim-airline/wiki/FAQ).
# Screenshots
A full list of screenshots can be found in the [Wiki](https://github.com/bling/vim-airline/wiki/Screenshots).
A full list of screenshots can be found in the [Wiki][n].
# Contributions
@ -71,6 +71,7 @@ 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.
* 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.
* if you submit a theme, please create a screenshot so it can be added to the [Wiki][n].
# License
@ -90,6 +91,7 @@ Distributed under the same terms as the Vim license. See `:help license`.
[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

19
doc/airline.txt
View File

@ -27,7 +27,7 @@ another statusline?
==============================================================================
NAME *airline-name*
Why's it called airline?
Why is it named airline?
I wrote this on an airplane, and since it's light as air it turned out to be a
good name :-)
@ -58,8 +58,7 @@ values):
let g:airline_enable_syntastic=1
<
* change the theme (available options: dark, light, simple, badwolf,
solarized, solarized2)
* change the default theme
>
let g:airline_theme='dark'
<
@ -93,6 +92,12 @@ values):
let g:airline_exclude_preview = 0
<
==============================================================================
COMMANDS *airline-commands*
:AirlineTheme {theme-name} *:AirlineTheme*
Displays or changes the current theme.
==============================================================================
CUSTOMIZATION *airline-customization*
@ -128,7 +133,7 @@ with the usual statusline syntax.
>
" here are the the default values
let g:airline_section_a (the mode indicator)
let g:airline_section_a (the mode/paste indicator)
let g:airline_section_b (the fugitive branch indicator)
let g:airline_section_c (bufferline or filename)
let g:airline_section_gutter (syntastic and readonly flag)
@ -157,12 +162,6 @@ example that you could add to your vimrc:
call add(g:airline_window_override_funcrefs, function('MyPlugin'))
<
==============================================================================
COMMANDS *airline-commands*
>
:AirlineTheme {theme-name} *:AirlineTheme*
Displayes or changes the current theme.
==============================================================================
CONTRIBUTIONS *airline-contributions*