tyler.durden
/
powerline
mirror of https://github.com/powerline/powerline.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update usage docs 

Refs #79.
This commit is contained in:
Kim Silkebækken 2013-01-21 10:14:21 +01:00
parent ccc18e8401
commit 7db8aa074f
1 changed files with 24 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/source/overview.rst
View File

@ -102,20 +102,37 @@ Usage
Vim statusline
^^^^^^^^^^^^^^
If Powerline is installed as a Python package, you can enable the vim plugin
by adding the following line to your ``vimrc``::
Regular installation
********************
**The recommended way of installing Powerline is as a Python package.**
You can then enable the vim plugin by adding the following line to your
``vimrc``:
.. code-block:: vim
python from powerline.bindings.vim import source_plugin; source_plugin()
If Powerline is installed somewhere other than Python's site-packages
directories you'll have to source the vim plugin file with an absolute path
to the plugin location.
directories you'll either have to use a plugin manager like Vundle, or
source the vim plugin file with an absolute path to the plugin location.
Add the following line to your ``vimrc``, where ``{path}`` is the path to
the main Powerline project directory::
the main Powerline project directory:
.. code-block:: vim
source {path}/powerline/bindings/vim/plugin/source_plugin.vim
Vundle installation
*******************
If you're using Vundle you can add the following line to your ``vimrc``:
.. code-block:: vim
Bundle 'Lokaltog/powerline', {'rtp': 'powerline/bindings/vim/'}
Terminal prompts
^^^^^^^^^^^^^^^^