Merge pull request #659 from Mkaysi/install

Update INSTALL.md && .mailmap && restore INSTALL symlink
This commit is contained in:
Valentin Lorentz 2014-05-22 17:41:30 +02:00
commit 07e709fb96
3 changed files with 53 additions and 6 deletions

View File

@ -4,6 +4,7 @@ Mikaela Suomalainen <mikaela.suomalainen@outlook.com> Mikaela Suomalainen <mkays
Mikaela Suomalainen <mikaela.suomalainen@outlook.com> Mika Suomalainen <mkaysi@outlook.com> Mikaela Suomalainen <mikaela.suomalainen@outlook.com> Mika Suomalainen <mkaysi@outlook.com>
Mikaela Suomalainen <mikaela.suomalainen@outlook.com> Mika Suomalainen <mkaysi@users.sourceforge.net> Mikaela Suomalainen <mikaela.suomalainen@outlook.com> Mika Suomalainen <mkaysi@users.sourceforge.net>
Mikaela Suomalainen <mikaela.suomalainen@outlook.com> Mika Suomalainen <s.mika95@gmail.com> Mikaela Suomalainen <mikaela.suomalainen@outlook.com> Mika Suomalainen <s.mika95@gmail.com>
<mikaela.suomalainen@outlook.com> <Mkaysi@users.noreply.github.com>
<progval@progval.net> <progval@gmail.com> <progval@progval.net> <progval@gmail.com>
<progval@progval.net> <progval+github@progval.net> <progval@progval.net> <progval+github@progval.net>
<nyuszika7h@outlook.com> <nyuszika7h@cadoth.net> <nyuszika7h@outlook.com> <nyuszika7h@cadoth.net>

1
INSTALL Symbolic link
View File

@ -0,0 +1 @@
INSTALL.md

View File

@ -25,9 +25,9 @@ To install them, run
```pip install -r requirements.txt``` ```pip install -r requirements.txt```
or if you don't have or want to use root, or if you don't have or don't want to use root,
````pip --install-option=--prefix=$HOME/.local install -r requirements.txt``` ````pip install -r requirements.txt --install-option=--prefix=$HOME/.local```
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 the documents under [docs/], especially [GETTING_STARTED] and
@ -45,6 +45,8 @@ from there.
# UNIX/Linux/BSD # UNIX/Linux/BSD
If you use [Debian or Ubuntu, click here](INSTALL.md#Debian)
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 or python3-dev package installed, too. If you don't have need a python-dev or python3-dev package installed, too. If you don't have
a '/usr/lib/python2.x/distutils' directory or a '/usr/lib/python2.x/distutils' directory or
@ -52,6 +54,9 @@ a '/usr/lib/python2.x/distutils' directory or
'/usr/lib/python3.x/distutils' or '/usr/lib/python3.x/config/Makefile' (assuming '/usr/lib/python2.x' or '/usr/lib/python3.x' is where your Python '/usr/lib/python3.x/distutils' or '/usr/lib/python3.x/config/Makefile' (assuming '/usr/lib/python2.x' or '/usr/lib/python3.x' is where your Python
libs are installed), then you will need a python-dev or python3-dev package. libs are installed), then you will need a python-dev or python3-dev package.
## git
First start by git cloning Limnoria and moving to the cloned repository. First start by git cloning Limnoria and moving to the cloned repository.
``` ```
@ -61,7 +66,7 @@ cd Limnoria
The rest depends on do you have root access and do you want to perform global or local install. The rest depends on do you have root access and do you want to perform global or local install.
## Global install ### Global install
Run Run
@ -81,7 +86,7 @@ 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 in-depth wizard that provides a nice user interface for creating a
registry file for your bot. registry file for your bot.
## Local install ### Local install
Run Run
@ -109,7 +114,30 @@ echo 'PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc source ~/.bashrc
``` ```
# Upgrading ## Debian
For Debian and other distributions based on it (Ubuntu etc.), there are
packages. You can install them with
```
wget http://builds.progval.net/limnoria/limnoria-master-HEAD.deb
sudo dpkg -i limnoria-master-HEAD.deb
```
## Pip
To install with pip run
```
sudo pip install limnoria
```
If you wish to use Python 3 or 2 instead of default of your distribution
run `pipX` where X is either 2 or 3 instead of `pip`.
### Upgrading
#### git
To upgrade, return to the cloned Limnoria repository and run: To upgrade, return to the cloned Limnoria repository and run:
@ -121,6 +149,23 @@ and then install Limnoria normally. "python setup.py install" doesn't affect con
If you don't have the cloned Limnoria repository, clone it again using the installation instructions. If you don't have the cloned Limnoria repository, clone it again using the installation instructions.
### Debian
Simply do the same as before:
```
wget http://builds.progval.net/limnoria/limnoria-master-HEAD.deb
sudo dpkg -i limnoria-master-HEAD.deb
```
### Pip
To update with pip, add `--upgrade` to the end of the command:
```
pip install limnoria --upgrade
```
## Upgrading to Python 3 ## Upgrading to Python 3
Upgrading Python3 happens the same way, but if you want to move from 2 to 3 Upgrading Python3 happens the same way, but if you want to move from 2 to 3
@ -134,7 +179,7 @@ rm /usr/local/bin/supybot*
rm ~/.local/bin/supybot* rm ~/.local/bin/supybot*
``` ```
# Windows ## 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 to run Supybot under Windows (unless Python has fixed things). Current