Merge pull request #5 from Mkaysi/install.rst

Document installing with pip.
This commit is contained in:
Valentin Lorentz 2014-06-27 19:16:20 +02:00
commit 4f0bcd4a43

View File

@ -57,6 +57,57 @@ however.
Install Limnoria
----------------
With pip
--------
This guide uses `pip`_ (usually in package python-pip) and `git`_.
**Windows users:** `pip`_ also works on Windows and you need `msysgit`_ in
which setup you should specify to have UNIX tools in PATH.
.. _pip: http://pip.readthedocs.org/en/latest/installing.html#install-pip
.. _git: http://git-scm.com/
.. _msysgit: https://msysgit.github.io/
Global installation
^^^^^^^^^^^^^^^^^^^
You can either run these as root or prepend ``sudo`` in front of every
message.
In case you want to use the testing branch which might be more up-to date
**but less tested**, replace ``master`` with ``testing in the commands.
First we install Limnoria's requirements: ::
pip install -r https://raw.githubusercontent.com/ProgVal/Limnoria/master/requirements.txt
And then Limnoria itself: ::
pip install git+https://github.com/ProgVal/Limnoria.git@master
Local installation
^^^^^^^^^^^^^^^^^^
Simply add ``--user`` to the end of both commands. First we install
requirements and then Limnoria itself.::
pip install -r https://raw.githubusercontent.com/ProgVal/Limnoria/master/requirements.txt --user
pip install git+https://github.com/ProgVal/Limnoria.git@master --user
You might need to add $HOME/.local/bin to your PATH.::
echo 'PATH="$HOME/.local/bin:$PATH"' >> ~/.$(echo $SHELL|cut -d/ -f3)rc
source ~/.$(echo $SHELL|cut -d/ -f3)rc
Upgrading
^^^^^^^^^
To upgrade Limnoria, simply add ``--upgrade`` to the end of both commands.
With git
--------
We are now ready to install supybot itself. Most distributions have a supybot
package in the repositories. This is probably the easiest way to install. If
that is what you want to do, that's fine, and you're ready to move on to the