Mikaela/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria-doc.git synced 2024-11-25 13:39:31 +01:00
Code Issues Projects Releases Wiki Activity

use/install: we now require Python 3.4+

Browse Source
This commit is contained in:
James Lu 2020-03-18 23:57:19 -07:00
parent 64c444e025
commit dddb9f1a26
1 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
use/install.rst
View File

@ -109,14 +109,12 @@ If you followed the section above, skip this one.
Dependencies Dependencies
------------ ------------
The only mandatory dependency is `Python`_ 2.6 or greater. However, it is The only mandatory dependency is Python 3.4 or greater.
highly recommended you use Python 3.4 or greater.
You may also install chardet and feedparser, which are used by Limnoria if You may also install chardet and feedparser, which are used by Limnoria if
they are available. they are available.
The remaining of this guide will assume you have Python 3. If you don't, The remaining of this guide will assume you have Python 3.
replace `python3` by `python` in the given commands
.. _Python: http://www.python.org/ .. _Python: http://www.python.org/
@ -158,10 +156,10 @@ Global installation (with root access)
If you do not have root access, skip this section. If you do not have root access, skip this section.
If you are logged in as root, you can remove ``sudo`` from the install If you are logged in as root, you can remove ``sudo`` from the install
commands. commands.
*In case you want to use the testing branch which might be more up-to *In case you want to use the testing branch which might be more up-to
date BUT LESS TESTED, replace ``master`` with ``testing`` in the commands.* date BUT LESS TESTED, replace ``master`` with ``testing`` in the commands.*
First we install Limnoria's optional dependencies (you can skip this First we install Limnoria's optional dependencies (you can skip this
@ -181,7 +179,7 @@ Local installation (without root access)
If you have followed the previous section, skip this one. If you have followed the previous section, skip this one.
Simply add ``--user`` to the end of both commands. First we install Simply add ``--user`` to the end of both commands. First we install
requirements (you can skip it, but some features won't be available) requirements (you can skip it, but some features won't be available)
and then Limnoria itself.:: and then Limnoria itself.::
@ -203,11 +201,11 @@ We are now ready to configure Supybot. Supybot creates quite a few auxiliary
files/directories to store its runtime data. It is thus recommended to create files/directories to store its runtime data. It is thus recommended to create
an empty directory from which you'll be running supybot, to keep all the data an empty directory from which you'll be running supybot, to keep all the data
in a nice dedicated location. For example, you may create a 'runbot' directory in a nice dedicated location. For example, you may create a 'runbot' directory
inside your home directory. inside your home directory.
Now you can cd to your 'runbot' directory, and from within it run Now you can cd to your 'runbot' directory, and from within it run
``supybot-wizard``, which will walk you through a series of questions to ``supybot-wizard``, which will walk you through a series of questions to
generate the bot config file. generate the bot config file.
One thing to make sure to do in the wizard, to make your life easier down the One thing to make sure to do in the wizard, to make your life easier down the
line, is to select **y** for the *Would you like to add an owner user for your line, is to select **y** for the *Would you like to add an owner user for your
@ -217,7 +215,7 @@ that you can later ''identify'' with the bot on IRC and administer it.
Once you generate the config file, which will be named ``yourbotnick.conf`` Once you generate the config file, which will be named ``yourbotnick.conf``
(where "yourbotnick" is the nick you have chosen for your bot in the wizard), (where "yourbotnick" is the nick you have chosen for your bot in the wizard),
it will be placed in your 'runbot' directory. (As long as you leave the default it will be placed in your 'runbot' directory. (As long as you leave the default
answer to the ''Where would you like to create these directories?'' question.) answer to the ''Where would you like to create these directories?'' question.)
Now to start the bot, run, still from within the 'runbot' directory:: Now to start the bot, run, still from within the 'runbot' directory::