Mikaela/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria-doc.git synced 2025-02-19 23:10:43 +01:00
Code Issues Projects Releases Wiki Activity

use/install: fix typos

Browse Source
This commit is contained in:
Valentin Lorentz 2021-04-05 11:57:41 +02:00
parent 25847931cf
commit d1bf6cf576
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
use/install.rst
View File

@ -119,7 +119,7 @@ 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. If you don't,
replace `python3` by `python` in the given commands replace ``python3`` with ``python`` in the given commands
.. _Python: http://www.python.org/ .. _Python: http://www.python.org/
@ -138,8 +138,8 @@ the case, open up a terminal, start python, and run:
import distutils import distutils
If it works, you're good to go. Otherwise, install the `python3-dev` or If it works, you're good to go. Otherwise, install the ``python3-dev`` or
`python3-devel` package and try again. ``python3-devel`` package and try again.
You may also install "manually" by downloading the source archive from You may also install "manually" by downloading the source archive from
http://python.org, and compiling it. That is outside the scope of this guide, http://python.org, and compiling it. That is outside the scope of this guide,
@ -152,7 +152,7 @@ In the next section of this guide we will use `pip`_, which is a generic
way of installing Python software. way of installing Python software.
There are some :ref:`alternative install methods <alternative-install>` There are some :ref:`alternative install methods <alternative-install>`
at the bottom of this guide, if you don't want to use `pip`. at the bottom of this guide, if you don't want to use ``pip``.
.. _pip: http://pip.readthedocs.org/en/latest/installing.html#install-pip .. _pip: http://pip.readthedocs.org/en/latest/installing.html#install-pip
@ -161,30 +161,30 @@ 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 If 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, install Limnoria's optional dependencies (you can skip this
step, but some features won't be available):: step, but some features won't be available)::
sudo python3 -m pip install -r https://raw.githubusercontent.com/ProgVal/Limnoria/master/requirements.txt --upgrade sudo python3 -m pip install -r https://raw.githubusercontent.com/ProgVal/Limnoria/master/requirements.txt --upgrade
And then Limnoria itself:: Then Limnoria itself::
sudo python3 -m pip install limnoria --upgrade sudo python3 -m pip install limnoria --upgrade
If you have an error saying `No module named pip`, install `pip` using If you have an error saying ``No module named pip``, install ``pip`` using
your package manager (the package is usually named `python3-pip`). your package manager (the package is usually named ``python3-pip``).
Local installation (without root access) 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.::
@ -196,7 +196,7 @@ You might need to add $HOME/.local/bin to your PATH.::
echo 'PATH="$HOME/.local/bin:$PATH"' >> ~/.$(echo $SHELL|cut -d/ -f3)rc echo 'PATH="$HOME/.local/bin:$PATH"' >> ~/.$(echo $SHELL|cut -d/ -f3)rc
source ~/.$(echo $SHELL|cut -d/ -f3)rc source ~/.$(echo $SHELL|cut -d/ -f3)rc
If you have an error saying `No module named pip`, install `pip` using this If you have an error saying ``No module named pip``, install ``pip`` using this
guide: https://pip.pypa.io/en/stable/installing/ guide: https://pip.pypa.io/en/stable/installing/
Configuration Configuration
@ -206,11 +206,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
@ -220,7 +220,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::
@ -247,8 +247,8 @@ can use one of these methods:
* Use `git`_ to clone the `Limnoria repository`_ and follow the * Use `git`_ to clone the `Limnoria repository`_ and follow the
instructions in `Limnoria's README.md`_. instructions in `Limnoria's README.md`_.
* Click the "Download ZIP" button at the `Limnoria repository`_. Then, * Click the "Download ZIP" button at the `Limnoria repository`_. Then,
extract the zipball to some temporary directory, and ``cd`` into the extract the zipball to some temporary directory, and ``cd`` to the
`Limnoria-master` directory which contains the extracted code. ``Limnoria-master`` directory which contains the extracted code.
.. _ProgVal's build repo: https://builds.progval.net/limnoria/ .. _ProgVal's build repo: https://builds.progval.net/limnoria/
.. _Limnoria repository: https://github.com/ProgVal/Limnoria .. _Limnoria repository: https://github.com/ProgVal/Limnoria