From fa1d6bfeb04b1a4f793b2ac32f91f28a8e6f2a83 Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Fri, 27 Jun 2014 18:23:55 +0300 Subject: [PATCH] install.rst: add pip --- use/install.rst | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/use/install.rst b/use/install.rst index 82a11ea..5a986f2 100644 --- a/use/install.rst +++ b/use/install.rst @@ -57,6 +57,49 @@ however. Install Limnoria ---------------- +Easy to follow install guide +---------------------------- + +This guide requires `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. + +First we 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 + +Other methods +------------- + 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