From 64c444e025a4d2a1787334cd1b57838693c741c5 Mon Sep 17 00:00:00 2001 From: James Lu Date: Wed, 18 Mar 2020 23:56:19 -0700 Subject: [PATCH 1/3] use/install: update Arch Linux, FreeBSD package names --- use/install.rst | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/use/install.rst b/use/install.rst index 46bdf05..0938607 100644 --- a/use/install.rst +++ b/use/install.rst @@ -71,23 +71,20 @@ Port: .. code-block:: bash - cd /usr/ports/irc/py-limnoria && sudo PYTHON_VERSION=3.5 make install clean - -You can omit ``PYTHON_VERSION=3.5`` if you want to build for Python 2.7, -or if you have ``DEFAULT_VERSIONS=python=3.5`` in `/etc/make.conf`. + cd /usr/ports/irc/py-limnoria && sudo PYTHON_VERSION=3.7 make install clean Package: .. code-block:: bash - sudo pkg install py27-limnoria + sudo pkg install py37-limnoria -On Archlinux +On Arch Linux ------------ -You can install Limnoria `from AUR`_. +You can install Limnoria `from the AUR`_. -.. _from AUR: https://aur.archlinux.org/packages/limnoria-python3-git/ +.. _from the AUR: https://aur.archlinux.org/packages/limnoria-git/ On Gentoo --------- From dddb9f1a261764b15b4f4a7a84b7de30b883c63c Mon Sep 17 00:00:00 2001 From: James Lu Date: Wed, 18 Mar 2020 23:57:19 -0700 Subject: [PATCH 2/3] use/install: we now require Python 3.4+ --- use/install.rst | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/use/install.rst b/use/install.rst index 0938607..da97812 100644 --- a/use/install.rst +++ b/use/install.rst @@ -109,14 +109,12 @@ If you followed the section above, skip this one. Dependencies ------------ -The only mandatory dependency is `Python`_ 2.6 or greater. However, it is -highly recommended you use Python 3.4 or greater. +The only mandatory dependency is Python 3.4 or greater. You may also install chardet and feedparser, which are used by Limnoria if they are available. -The remaining of this guide will assume you have Python 3. If you don't, -replace `python3` by `python` in the given commands +The remaining of this guide will assume you have Python 3. .. _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 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. -*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.* 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. -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) 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 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 -inside your home directory. +inside your home directory. 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 -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 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`` (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 -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:: From 137e834d6377592201da8d0db90e21fac9b562fd Mon Sep 17 00:00:00 2001 From: James Lu Date: Thu, 19 Mar 2020 00:02:07 -0700 Subject: [PATCH 3/3] use/install: update Debian / Ubuntu instructions with links to backports Closes GH-85. --- use/install.rst | 23 ++++++++--------------- 1 file changed, 8 insertions(+), 15 deletions(-) diff --git a/use/install.rst b/use/install.rst index da97812..526ed54 100644 --- a/use/install.rst +++ b/use/install.rst @@ -25,25 +25,18 @@ Install Install using your OS' package manager ====================================== -On Debian (8.0 and above) -------------------------- - -.. code-block:: bash - - sudo aptitude install limnoria - -If you have Debian 8.0 (Jessie), this command won't work unless you -have `Backports`_ repositories configured. - -.. _Backports: https://wiki.debian.org/Backports - -On Ubuntu (16.10 and above) ---------------------------- +On Debian (8.0 and above) or Ubuntu (16.10 and above) +----------------------------------------------------- .. code-block:: bash sudo apt-get install limnoria +Note that stable / LTS releases may not have the latest features or bug fixes for Limnoria. If you want a newer version than what's in the default repositories, you can enable `Backports`_ on Debian or `Unit 193's PPA`_ on Ubuntu. + +.. _Backports: https://wiki.debian.org/Backports +.. _Unit 193's PPA: https://launchpad.net/~unit193/+archive/ubuntu/limnoria + On Fedora (23 and above) ------------------------ @@ -80,7 +73,7 @@ Package: sudo pkg install py37-limnoria On Arch Linux ------------- +------------- You can install Limnoria `from the AUR`_.