From 5676e8a5858c4207a131fd93c3953c74b3851fa1 Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Sun, 4 Nov 2012 15:02:21 +0200 Subject: [PATCH] Limnoria: type to Supybot-wizard --- articles/guides/Limnoria.html | 68 +++++++++++++++++++++++-- articles/guides/Limnoria.html.md | 87 ++++++++++++++++++++++++++++++-- 2 files changed, 148 insertions(+), 7 deletions(-) diff --git a/articles/guides/Limnoria.html b/articles/guides/Limnoria.html index 7e1adf0..c79a428 100644 --- a/articles/guides/Limnoria.html +++ b/articles/guides/Limnoria.html @@ -1,7 +1,7 @@ - + Installing & running Limnoria. @@ -21,7 +21,7 @@ Installing & running Limnoria.

sudo su

Then download the Debian package. Here you have to choice do you install the stable version or testing version.

-

Replace "VERSIONHERE" with "master" to get stable version or "testing" to get unstable version.

+

Replace "VERSIONHERE" with "master" to get stable version or "testing" to get testing version.

wget http://compiler.progval.net/limnoria-VERSIONHERE-HEAD.deb
 dpkg -i limnoria-VERSIONHERE-HEAD.deb
 apt-get install -f
@@ -29,7 +29,69 @@ apt-get install -f

Upgrading

To upgrade just run the steps above. Remember that the Debian packages are daily builds, so they are changed every day. You can see the latest change on [compiler.progval.net]. The "-HEAD" packages are always the most recent version.

From source

-

I recommend that you have [git] installed.

+

I recommend that you have [git] installed, because it will make upgrading easier and you don't have to find the [download links] from [GitHub].

+

If you are going to do a global installation you might want to become root now, otherwise skip the next command

+
+

sudo su

+
+

Now download (or "clone") the git repository.

+
+

git clone git://github.com/ProgVal/Limnoria.git

+
+

move into the cloned repository

+
+

cd Limnoria

+
+

and decide do you want install stable or testing version.

+

In case you want the testing version, change into the testing branch. If you want the stable version skip this.

+
+

git checkout -b testing origin/testing

+
+

Now if you are root and what global installation, you run

+
+

python setup.py install

+
+

or local installation

+
+

python setup.py install --user

+
+

Limnoria is now installed and you can move to configuring it.

+

[Arch Linux] users (and users of other distributions which use python3 by default instead of python"): REPLACE "python" WITH "python2" in all commands!

+

Upgrading

+

Return to the git repository or if you have removed it, follow the installation steps again.

+

Update the cloned repository by running

+
+

git pull

+
+

and then reinstall

+
+

python setup.py install

+
+

or only for current user

+
+

python setup.py install --user

+
+
+ +

Configuring the bot

+

If you installed [Limnoria] as root, you can skip the next section and move to "running Supybot-wizard".

+

Preparing locally installed Limnoria for use

+

Limnoria's binaries were installed to ~/.local/bin which isn't in default $PATH. This means that you must either type the whole path always when you want to run Limnoria or add ~/.local/bin to your PATH. We do the previously mentioned.

+

You can add it to the PATH by running the following commands:

+
echo "PATH=$HOME/.local/bin:$PATH" >> ~/.bashrc
+echo "PATH=$HOME/.local/bin:$PATH" >> ~/.zshrc
+

If you type only one ">" instead of ">>" in those commands, you will replace the content of those files with "PATH=HOME / . local / bin: PATH" instead of appending it into them.

+

then run

+
+

source .bashrc

+
+

or with zsh

+
+

source .zshrc

+
+

and you should be able to run the commands without needing to type the whole PATH, so you can now move into configuring.

+

NOTE: You don't need to do this again after upgrading.

+

Running the Supybot-wizard

diff --git a/articles/guides/Limnoria.html.md b/articles/guides/Limnoria.html.md index 76f5903..a5044be 100644 --- a/articles/guides/Limnoria.html.md +++ b/articles/guides/Limnoria.html.md @@ -3,8 +3,8 @@ - - + + Installing & running Limnoria. @@ -29,7 +29,7 @@ First become root by running Then download the Debian package. Here you have to choice do you install the stable version or testing version. -Replace "VERSIONHERE" with "master" to get stable version or "testing" to get unstable version. +Replace "VERSIONHERE" with "master" to get stable version or "testing" to get testing version. ``` wget http://compiler.progval.net/limnoria-VERSIONHERE-HEAD.deb @@ -45,6 +45,85 @@ To upgrade just run the steps above. Remember that the Debian packages are daily ## From source -I recommend that you have [git] installed. +I recommend that you have [git] installed, because it will make upgrading easier and you don't have to find the [download links] from [GitHub]. + +If you are going to do a global installation you might want to become root now, otherwise skip the next command + +> sudo su + +Now download (or "clone") the git repository. + +> git clone git://github.com/ProgVal/Limnoria.git + +move into the cloned repository + +> cd Limnoria + +and decide do you want install stable or testing version. + +In case you want the testing version, change into the testing branch. If you want the stable version skip this. + +> git checkout -b testing origin/testing + +Now if you are root and what global installation, you run + +> python setup.py install + +or local installation + +> python setup.py install --user + +Limnoria is now installed and you can move to configuring it. + +[Arch Linux] users (and users of other distributions which use python3 by default instead of python"): REPLACE "python" WITH "python2" in all commands! + +### Upgrading + +Return to the git repository or if you have removed it, follow the installation steps again. + +Update the cloned repository by running + +> git pull + +and then reinstall + +> python setup.py install + +or only for current user + +> python setup.py install --user + +
+ +# Configuring the bot + +If you installed [Limnoria] as root, you can skip the next section and move to "running Supybot-wizard". + +## Preparing locally installed Limnoria for use + +Limnoria's binaries were installed to ~/.local/bin which isn't in default $PATH. This means that you must either type the whole path always when you want to run Limnoria or add ~/.local/bin to your PATH. We do the previously mentioned. + +You can add it to the PATH by running the following commands: + +``` +echo "PATH=$HOME/.local/bin:$PATH" >> ~/.bashrc +echo "PATH=$HOME/.local/bin:$PATH" >> ~/.zshrc +``` + +If you type only one ">" instead of ">>" in those commands, you will replace the content of those files with "PATH=$HOME/.local/bin:$PATH" instead of appending it into them. + +then run + +> source .bashrc + +or with zsh + +> source .zshrc + +and you should be able to run the commands without needing to type the whole PATH, so you can now move into configuring. + +NOTE: You don't need to do this again after upgrading. + +## Running the Supybot-wizard