From fa1d6bfeb04b1a4f793b2ac32f91f28a8e6f2a83 Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Fri, 27 Jun 2014 18:23:55 +0300 Subject: [PATCH 1/5] 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 From 4b2fb3951bfb3156d2378ccf4d612dcb5f0307db Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Fri, 27 Jun 2014 19:32:36 +0300 Subject: [PATCH 2/5] install.rst: fix things with help from @ProgVal . --- use/install.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/use/install.rst b/use/install.rst index 5a986f2..9874113 100644 --- a/use/install.rst +++ b/use/install.rst @@ -60,9 +60,9 @@ Install Limnoria Easy to follow install guide ---------------------------- -This guide requires `pip` (usually in package python-pip) and `git`. +This guide requires `pip`_ (usually in package python-pip) and `git`_. -*Windows users: `pip` also works on Windows and you need `msysgit` in +*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 @@ -72,7 +72,7 @@ which setup you should specify to have UNIX tools in PATH.* Global installation ^^^^^^^^^^^^^^^^^^^ -You can either run these as root or prepend ``sudo `` in front of every +You can either run these as root or prepend ``sudo`` in front of every message. First we Limnoria's requirements: From 32fa8b28c787e5d8879e62a6e6bee422d6298690 Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Fri, 27 Jun 2014 19:41:45 +0300 Subject: [PATCH 3/5] install.rst: fix clode blocks with help from @ProgVal --- use/install.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/use/install.rst b/use/install.rst index 9874113..7758064 100644 --- a/use/install.rst +++ b/use/install.rst @@ -62,8 +62,8 @@ 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.* +**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/ @@ -75,11 +75,11 @@ Global installation You can either run these as root or prepend ``sudo`` in front of every message. -First we Limnoria's requirements: +First we Limnoria's requirements: :: pip install -r https://raw.githubusercontent.com/ProgVal/Limnoria/master/requirements.txt -And then Limnoria itself: +And then Limnoria itself: :: pip install git+https://github.com/ProgVal/Limnoria.git@master @@ -87,12 +87,12 @@ Local installation ^^^^^^^^^^^^^^^^^^ Simply add ``--user`` to the end of both commands. First we install -requirements and then Limnoria itself. +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. +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 From 920344191529865d1ce7f405792c91ae3e2b47ea Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Fri, 27 Jun 2014 19:51:22 +0300 Subject: [PATCH 4/5] install.rst: fix typo. --- use/install.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/use/install.rst b/use/install.rst index 7758064..d567dbb 100644 --- a/use/install.rst +++ b/use/install.rst @@ -75,7 +75,7 @@ Global installation You can either run these as root or prepend ``sudo`` in front of every message. -First we Limnoria's requirements: :: +First we install Limnoria's requirements: :: pip install -r https://raw.githubusercontent.com/ProgVal/Limnoria/master/requirements.txt From bb525b0f4442527e0f384c2789a4c5580fd8a3d4 Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Fri, 27 Jun 2014 20:02:15 +0300 Subject: [PATCH 5/5] install.rst: Do changes suggested by @ProgVal & add upgrading with pip. --- use/install.rst | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/use/install.rst b/use/install.rst index d567dbb..654edbb 100644 --- a/use/install.rst +++ b/use/install.rst @@ -57,10 +57,10 @@ however. Install Limnoria ---------------- -Easy to follow install guide ----------------------------- +With pip +-------- -This guide requires `pip`_ (usually in package python-pip) and `git`_. +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. @@ -75,6 +75,9 @@ 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 @@ -97,8 +100,13 @@ 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 -------------- +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