INSTALL: update installation guide.

INSTALL.md

@@ -1,17 +1,20 @@
-Common
+# Common
-======
 
-  First things first: Supybot *requires* at least Python 2.6.  There
+    First things first: Supybot *requires* at least Python 2.6.  There
-ain't no getting around it.  You can get it from http://www.python.org/.
+isn't any way to get around it.  You can get it from [Python homepage].
 
-Recommended Software
+[Python homepage]:http://python.org/
-====================
 
-    PySQLite -- Version 2.x
+# Recommended Software
 
-    Twisted -- Version 1.2.0 or greater
+    [PySQLite] -- Version 2.x
 
-  For more information and help on how to use Supybot, checkout
+    [Twisted] -- Version 1.2.0 or greater
+
+[PySQLite]:https://code.google.com/p/pysqlite/
+[Twisted]:http://twistedmatrix.com/trac/
+
+    For more information and help on how to use Supybot, checkout
 the documents under docs/ (especially GETTING_STARTED and
 CONFIGURATION).
 
@@ -20,8 +23,7 @@ running.  We've split this document up to address the different
 methods, so find the section for your operating system and continue
 from there.
 
-UNIX/Linux/BSD
+# UNIX/Linux/BSD
-==============
 
   If you're installing Python using your distributor's packages, you may
 need a python-dev package installed, too.  If you don't have a
@@ -30,11 +32,24 @@ need a python-dev package installed, too.  If you don't have a
 where your Python libs are installed), then you will need a python-dev
 package.
 
-  After you extract Supybot and cd into the supybot directory just
+First start by git cloning Limnoria and moving to the cloned repository.
-created, you'll want to run (as root) 'python setup.py install'.  This
+
-will install Supybot globally.  If you need to install locally for
+```
-whatever reason, see the notes at the end of this section.  You'll then
+git clone git://github.com/ProgVal/Limnoria.git
-have several new programs installed where Python scripts are normally
+cd Limnoria
+```
+
+The rest depends on do you have root access and do you want to perform global or local install.
+
+## Global install
+
+Run
+
+```
+python setup.py install
+```
+
+Now you have several new programs installed where Python scripts are normally
 installed on your system ('/usr/bin' or '/usr/local/bin' are common on
 UNIX systems).  The two that might be of particular interest to you, the
 new user, are 'supybot' and 'supybot-wizard'.  The former, 'supybot', is
@@ -42,18 +57,29 @@ the script to run an actual bot; the latter, 'supybot-wizard', is an
 in-depth wizard that provides a nice user interface for creating a
 registry file for your bot.
 
-Local Install
+## Local install
--------------
 
-  You can install Supybot in a local directory by using the '--user'
+Run
-  option when running 'setup.py'.  E.g., 'python setup.py install
-  --user' to install into your home directory.  You'll now have
-  a $HOME/.local/bin directory containing Supybot programs ('supybot',
-  'supybot-wizard', etc.) and a $HOME/.local/lib directory containing the
-  Supybot libraries.
 
-Windows
+```
-=======
+python setup.py install --user
+```
+
+and you will have new programs installed in ~/.local/bin. The two that might be of particular interest to you, the
+new user, are 'supybot' and 'supybot-wizard'.  The former, 'supybot', is
+the script to run an actual bot; the latter, 'supybot-wizard', is an
+in-depth wizard that provides a nice user interface for creating a
+registry file for your bot.
+
+By default you must run the bot with full path to the binary unless you specify $PATH.
+
+Run and add the following command to your shellrc, which is usually ~/.bashrc or ~/.zshrc , so you can run the programs without needing to write full paths to the binaries.
+
+```
+PATH=$HOME/.local:$PATH
+```
+
+# Windows
 
   **Note**: If you are using an IPV6 connection, you will not be able
 to run Supybot under Windows (unless Python has fixed things).  Current
@@ -68,14 +94,21 @@ Python's directory to your path.  If you installed Python using the
 default settings, you would then do the following in the command prompt
 (otherwise change the path to match your settings)::
 
-    set PATH=C:\Python2x\;%PATH%
+```
+set PATH=C:\Python2x\;%PATH%
+```
 
   You should now be able to type 'python' to start the Python
 interpreter.  Exit by pressing CTRL-Z and then Return.  Now that that's
 setup, you'll want to cd into the directory that was created when you
 unzipped Supybot; I'll assume you unzipped it to 'C:\Supybot' for these
-instructions.  From 'C:\Supybot', run 'python setup.py install'.  This
+instructions.  From 'C:\Supybot', run 
-will install Supybot under 'C:\Python2x\'.  You will now have several new
+
+```
+python setup.py install
+```
+
+This will install Supybot under 'C:\Python2x\'.  You will now have several new
 programs installed in 'C:\Python2x\Scripts\'.  The two that might be of
 particular interest to you, the new user, are 'supybot' and 'supybot-wizard'.
 The former, 'supybot', is the script to run an actual bot; the latter,