aboutsummaryrefslogtreecommitdiff
path: root/doc/administration/installation.rst
diff options
context:
space:
mode:
authorDaniel Schadt <kingdread@gmx.de>2024-04-05 22:34:08 +0200
committerDaniel Schadt <kingdread@gmx.de>2024-04-05 22:34:45 +0200
commit4f96b9c3f39213a5f6ae631c7c820f63fc2219d5 (patch)
tree002a30ecabab225d77e3df0e89fdb3584a04cc6b /doc/administration/installation.rst
parent6ee21f6c078891e4453415cbebd6b7d591185c5f (diff)
downloadfietsboek-4f96b9c3f39213a5f6ae631c7c820f63fc2219d5.tar.gz
fietsboek-4f96b9c3f39213a5f6ae631c7c820f63fc2219d5.tar.bz2
fietsboek-4f96b9c3f39213a5f6ae631c7c820f63fc2219d5.zip
documentation improvements
Diffstat (limited to 'doc/administration/installation.rst')
-rw-r--r--doc/administration/installation.rst38
1 files changed, 31 insertions, 7 deletions
diff --git a/doc/administration/installation.rst b/doc/administration/installation.rst
index fd0def5..c21af59 100644
--- a/doc/administration/installation.rst
+++ b/doc/administration/installation.rst
@@ -50,17 +50,41 @@ Installing the Python Modules
-----------------------------
The Python package manager takes care of installing all dependencies, all you
-need to do is tell it to install Fietsboek:
+need to do is tell it to install Fietsboek. How exactly depends on your way of
+acquiring Fietsboek.
+
+Via PIP
+^^^^^^^
+
+Fietsboek is available in the Python Package Index as `fietsboek
+<https://pypi.org/project/fietsboek/>`__ and can be installed directly via
+``pip``:
.. code:: bash
- # Assuming that we are in the Fietsboek folder
- .venv/bin/pip install .
- # Alternatively
- .venv/bin/pip path/to/fietsboek/repository
+ .venv/bin/pip install fietsboek
+
+Via Git
+^^^^^^^
+
+If you prefer to work with the source version (e.g. for development purposes),
+you should use Git to clone the repository from one of its mirrors:
+
+* Main on Gitlab: https://gitlab.com/dunj3/fietsboek
+* Mirror on Codeberg: https://codeberg.org/dunj3/fietsboek
+
+.. code:: bash
+
+ git clone https://gitlab.com/dunj3/fietsboek
+ .venv/bin/pip install ./fietsboek
+ # For development, you can use -e for an editable installation:
+ .venv/bin/pip install -e ./fietsboek
+
+Optional: Install lxml
+^^^^^^^^^^^^^^^^^^^^^^
-Optionally, you can install ``lxml``, which provides a faster XML parser to
-process the GPX files:
+In any case, you can optionally install ``lxml``, which provides a faster XML
+parser to process the GPX files:
.. code:: bash