From b965e1222715a2756985a5f733f472502865d054 Mon Sep 17 00:00:00 2001
From: Mikaela Suomalainen <mikaela.suomalainen@outlook.com>
Date: Sun, 29 Jun 2014 12:21:43 +0300
Subject: [PATCH] Supybot: add quick installation guide.

---
 Supybot.html    | 19 ++++++++++++++++++
 Supybot.html.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 71 insertions(+)

diff --git a/Supybot.html b/Supybot.html
index 05d4168cd..652e64d8b 100644
--- a/Supybot.html
+++ b/Supybot.html
@@ -55,6 +55,25 @@ Security issues of Supybot
 <p><a href="https://github.com/ProgVal/Limnoria/wiki/LGC">Limnoria modifications when compared to Gribble.</a> Features of Gribble have been fully merged to Limnoria.</p>
 <p>Your current botname.conf is <strong>100% compatible with forks</strong>.</p>
 <p><a href="irc://irc.freenode.net/#supybot,#gribble,#limnoria">Join Supybot channels on freenode!</a></p>
+<h2 id="installing-forks">Installing forks</h2>
+<h3 id="for-all-of-them.">For all of them.</h3>
+<p>You should install [pip] (usually python-pip in repositories) and [git].</p>
+<p>Windows users should also install [pip] and [msysgit] and in [msysgit] select to run <strong>unix tools in PATH</strong>.</p>
+<p>Note: pip is included with Python =&lt; 3.4! Python 3 is only supported by Limnoria.</p>
+<p>For <strong>rootless installation and upgrading</strong>, please see <a href="http://supybot.aperio.fr/doc/use/install.html#local-installation">Limnoria's documentation.</a> which you should be able to modify to install stock Supybot or gribble with the information below.</p>
+<p>If you don't have sudo, please simply remove it from beginnings of lines and run the commands as root or Administrator.</p>
+<p>[pip]: [msysgit]:</p>
+<h3 id="supybot">Supybot</h3>
+<p><strong>Not recommended as it's not actively developed.</strong></p>
+<pre><code>sudo pip install git+git://supybot.git.sourceforge.net/gitroot/gitroot/supybot/supybot</code></pre>
+<h3 id="gribble">gribble</h3>
+<p>Less actively developed than Limnoria and doesn't support Python 3.</p>
+<pre><code>sudo pip install git+git://gribble.git.sourceforge.net/gitroot/gribble/gribble</code></pre>
+<h3 id="limnoria">Limnoria</h3>
+<p>At the time of writing, the most active Supybot fork which includes embedded HTTPd for plugins needing it, supports other languages than English and also runs with Python 3.</p>
+<p>The first command installs requirements of Limnoria and the second Limnoria itself. Only Limnoria has requirements.txt file at the moment.</p>
+<pre><code>sudo pip install -r https://raw.githubusercontent.com/ProgVal/Limnoria/master/requirements.txt
+sudo pip install git+https://github.com/ProgVal/Limnoria.git@master</code></pre>
 <p>[Changelog of this page.]</p>
 [Changelog of this page.]:https://github.com/Mkaysi/Limnoria/commits/gh-pages/Supybot.html
 <script>
diff --git a/Supybot.html.md b/Supybot.html.md
index e02225539..482359118 100644
--- a/Supybot.html.md
+++ b/Supybot.html.md
@@ -120,6 +120,58 @@ Your current botname.conf is <strong>100% compatible with forks</strong>.
 [PluginDownloader]:https://github.com/ProgVal/Limnoria/tree/master/plugins/PluginDownloader
 [Join Supybot channels on freenode!]:irc://irc.freenode.net/#supybot,#gribble,#limnoria
 
+## Installing forks
+
+### For all of them.
+
+You should install [pip] (usually python-pip in repositories) and [git].
+
+Windows users should also install [pip] and [msysgit] and in [msysgit] 
+select to run **unix tools in PATH**.
+
+Note: pip is included with Python =< 3.4! Python 3 is only supported by 
+Limnoria.
+
+For **rootless installation and upgrading**, please see 
+[Limnoria's documentation.](http://supybot.aperio.fr/doc/use/install.html#local-installation) which you should be able to modify to install stock 
+Supybot or gribble with the information below.
+
+If you don't have sudo, please simply remove it from beginnings of lines 
+and run the commands as root or Administrator.
+
+[pip]:
+[msysgit]:
+
+### Supybot
+
+**Not recommended as it's not actively developed.**
+
+```
+sudo pip install git+git://supybot.git.sourceforge.net/gitroot/gitroot/supybot/supybot
+```
+
+### gribble
+
+Less actively developed than Limnoria and doesn't support Python 3.
+
+```
+sudo pip install git+git://gribble.git.sourceforge.net/gitroot/gribble/gribble
+```
+
+### Limnoria
+
+At the time of writing, the most active Supybot fork which includes 
+embedded HTTPd for plugins needing it, supports other languages than 
+English and also runs with Python 3.
+
+The first command installs requirements of Limnoria and the second 
+Limnoria itself. Only Limnoria has requirements.txt file at the moment.
+
+```
+sudo pip install -r https://raw.githubusercontent.com/ProgVal/Limnoria/master/requirements.txt
+sudo pip install git+https://github.com/ProgVal/Limnoria.git@master
+```
+
 [Changelog of this page.]
 
 [Changelog of this page.]:https://github.com/Mkaysi/Limnoria/commits/gh-pages/Supybot.html