From 73e33c511ef89c3fe3cf0c7e86d9b513adc288e2 Mon Sep 17 00:00:00 2001 From: Mika Suomalainen Date: Thu, 10 May 2012 11:26:39 +0300 Subject: [PATCH 1/4] INSTALL: update installation guide. --- INSTALL.md | 91 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 62 insertions(+), 29 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 66dae52d1..6f828fad6 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,17 +1,20 @@ -Common -====== +# Common - 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/. + First things first: Supybot *requires* at least Python 2.6. There +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 -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 -have several new programs installed where Python scripts are normally +First start by git cloning Limnoria and moving to the cloned repository. + +``` +git clone git://github.com/ProgVal/Limnoria.git +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' - 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. +Run -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 -will install Supybot under 'C:\Python2x\'. You will now have several new +instructions. From 'C:\Supybot', run + +``` +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, From 8ea1778ca04c3ecb79129d714e08e34be7ebf040 Mon Sep 17 00:00:00 2001 From: Mika Suomalainen Date: Thu, 10 May 2012 11:30:00 +0300 Subject: [PATCH 2/4] INSTALL.md fix b1359e1a9c2f0f88f18dca311c1651d88b58a7dc --- INSTALL.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 6f828fad6..63e7ca5bf 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,31 +1,30 @@ # Common - First things first: Supybot *requires* at least Python 2.6. There +First things first: Supybot *requires* at least Python 2.6. There isn't any way to get around it. You can get it from [Python homepage]. [Python homepage]:http://python.org/ # Recommended Software - [PySQLite] -- Version 2.x - - [Twisted] -- Version 1.2.0 or greater +[PySQLite] -- Version 2.x +[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 +For more information and help on how to use Supybot, checkout the documents under docs/ (especially GETTING_STARTED and CONFIGURATION). - So what do you do? That depends on which operating system you're +So what do you do? That depends on which operating system you're 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 - If you're installing Python using your distributor's packages, you may +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 '/usr/lib/python2.x/distutils' directory or '/usr/lib/python2.x/config/Makefile' (assuming '/usr/lib/python2.x' is @@ -81,12 +80,12 @@ PATH=$HOME/.local:$PATH # Windows - **Note**: If you are using an IPV6 connection, you will not be able +**Note**: If you are using an IPV6 connection, you will not be able to run Supybot under Windows (unless Python has fixed things). Current versions of Python for Windows are *not* built with IPV6 support. This isn't expected to be fixed until Python 2.4, at the earliest. - Now that you have Python installed, open up a command prompt. The +Now that you have Python installed, open up a command prompt. The easiest way to do this is to open the run dialog (Programs -> run) and type "cmd" (for Windows 2000/XP/2003) or "command" (for Windows 9x). In order to reduce the amount of typing you need to do, I suggest adding @@ -98,7 +97,7 @@ default settings, you would then do the following in the command prompt set PATH=C:\Python2x\;%PATH% ``` - You should now be able to type 'python' to start the Python +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 From 0704eee6d9ac34861e475f148d0f5038f3485a1c Mon Sep 17 00:00:00 2001 From: Mika Suomalainen Date: Thu, 10 May 2012 11:31:20 +0300 Subject: [PATCH 3/4] INSTALL.md: fix 4a6fa12cedc23ff431c5dc71673eb7fa206ba6cf --- INSTALL.md | 1 + 1 file changed, 1 insertion(+) diff --git a/INSTALL.md b/INSTALL.md index 63e7ca5bf..08b9e934d 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -8,6 +8,7 @@ isn't any way to get around it. You can get it from [Python homepage]. # Recommended Software [PySQLite] -- Version 2.x + [Twisted] -- Version 1.2.0 or greater [PySQLite]:https://code.google.com/p/pysqlite/ From 28dcc072815b1704a7705516eaa4c2f74a68942a Mon Sep 17 00:00:00 2001 From: Mika Suomalainen Date: Thu, 10 May 2012 11:51:59 +0300 Subject: [PATCH 4/4] INSTALL.md: Add upgrading instructions. --- INSTALL.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/INSTALL.md b/INSTALL.md index 08b9e934d..90e893d2e 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -79,6 +79,18 @@ Run and add the following command to your shellrc, which is usually ~/.bashrc or PATH=$HOME/.local:$PATH ``` +# Upgrading + +To upgrade, return to the cloned Limnoria repository and run: + +``` +git pull +``` + +and then install Limnoria normally. "python setup.py install" doesn't affect config files of the bot any way. + +If you don't have the cloned Limnoria repository, clone it again using the installation instructions. + # Windows **Note**: If you are using an IPV6 connection, you will not be able