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

README: show a screenshot and document what this plugin does

Browse Source 
fixes #1589
This commit is contained in:
Christian Brabandt 2017-11-14 23:43:04 +01:00
parent 52ce640534
commit f3aae5f72b
No known key found for this signature in database
GPG Key ID: F3F92DA383FDDE09
2 changed files with 52 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -4,6 +4,56 @@ Lean & mean status/tabline for vim that's light as air.
![img](https://github.com/vim-airline/vim-airline/wiki/screenshots/demo.gif)
When the plugin is correctly loaded, Vim will draw a nice statusline at the
bottom of each window.
That line consists of several sections, each one displaying some piece of
information. By default (without configuration) this line will look like this:
```
+-----------------------------------------------------------------------------+
|~ |
|~ |
|~ VIM - Vi IMproved |
|~ |
|~ version 8.0 |
|~ by Bram Moolenaar et al. |
|~ Vim is open source and freely distributable |
|~ |
|~ type :h :q<Enter> to exit |
|~ type :help<Enter> or <F1> for on-line help |
|~ type :help version8<Enter> for version info |
|~ |
|~ |
+-----------------------------------------------------------------------------+
| A | B | C X | Y | Z | [...] |
+-----------------------------------------------------------------------------+
```
The statusline is the colored line at the bottom, which contains the sections
(possibly in different colors):
section|meaning (example)
--------------------------
A | displays the mode + additional flags like crypt/spell/paste (INSERT)
B | VCS information (branch, hunk summary) (master)
C | filename + read-only flag (~/.vim/vimrc RO)
X | filetype (vim)
Y | file encoding[fileformat] (utf-8[unix])
Z | current position in the file
| percentage % ☰ current line/number of lines ln : column
| So this: 10% ☰ 10/100 ln : 20 means: >
| 10% - 10 percent
| ☰ 10 - current line 10
| /100 ln - of 100 lines
| : 20 - current column 20
[...] | additional sections (warning/errors/statistics)
| from external plugins (e.g. YCM/syntastic/...)
For a better look, those sections can be colored differently, depending on various conditions
(e.g. the mode or whether the current file is 'modified')
# Features
* Tiny core written with extensibility in mind ([open/closed principle][8]).

5
doc/airline.txt
View File

@ -32,9 +32,8 @@ INTRODUCTION *airline-intro*
vim-airline is a fast and lightweight alternative to powerline, written
in 100% vimscript with no outside dependencies.
When the plugin is correctly loaded, and Vim is configured for drawing a
'statusline' (set 'laststatus' to 2, to always display the airline
statusline) Vim will draw a nice statusline at the bottom of each window.
When the plugin is correctly loaded, Vim will draw a nice statusline at the
bottom of each window.
That line consists of several sections, each one displaying some piece of
information. By default (without configuration) this line will look like this: >