Make installation docs mention powerline-status first, reword them

This commit is contained in:
ZyX 2015-01-07 15:15:31 +03:00
parent 4b4964013b
commit 21e6e5ba5d
1 changed files with 14 additions and 13 deletions

View File

@ -40,28 +40,35 @@ Generic requirements
Pip installation
================
This project is currently unavailable from PyPI due to a naming conflict with an
unrelated project, thus you will have to use the following command to install
powerline with ``pip``:
Due to a naming conflict with an unrelated project powerline is available on
PyPI under the ``powerline-status`` name:
.. code-block:: sh
pip install powerline-status
is the preferred method because this will get you the latest release. To get
current development version
.. code-block:: sh
pip install --user git+git://github.com/powerline/powerline
. You may also choose to clone powerline repository somewhere and use
may be used. If powerline was already checked out into some directory
.. code-block:: sh
pip install --user --editable={path_to_powerline}
, but note that in this case ``pip`` will not install ``powerline`` executable
and you will have to do something like
is useful, but note that in this case ``pip`` will not install ``powerline``
executable and something like
.. code-block:: sh
ln -s {path_to_powerline}/scripts/powerline ~/.local/bin
(:file:`~/.local/bin` should be replaced with some path present in ``$PATH``).
will have to be done (:file:`~/.local/bin` should be replaced with some path
present in ``$PATH``).
.. note::
If your ISP blocks git protocol for some reason github also provides ``ssh``
@ -69,12 +76,6 @@ and you will have to do something like
(``git+https://github.com/powerline/powerline``) protocols. ``git`` protocol
should be the fastest, but least secure one though.
To install release version uploaded to PyPI use
.. code-block:: sh
pip install powerline-status
Fonts installation
==================