Skip to content

Commit

Permalink
Documentation: Improve section about installing Luftdatenpumpe
Browse files Browse the repository at this point in the history
From the previous version, it was not obvious how to make the
`luftdatenpumpe` command available system-wide, when having it installed
within a Python virtualenv.
  • Loading branch information
amotl committed Dec 17, 2022
1 parent e08e7b5 commit afe9da5
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions doc/setup/luftdatenpumpe.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,27 @@ Install Luftdatenpumpe
######################


*************
Prerequisites
*************
*****
Setup
*****

Install Luftdatenpumpe
======================
::
Install prerequisites::

apt install build-essential python3-dev libicu-dev

::
Install Luftdatenpumpe::

pip install luftdatenpumpe

*****
Notes
*****

.. note::

We recommend to use a Python `virtualenv <doc-virtualenv_>`_ to install and operate this
software independently from your local system-wide Python installation.
- We recommend to use a Python `virtualenv <doc-virtualenv_>`_ to install and operate this
software independently from your local system-wide Python installation.

- In order to make the ``luftdatenpumpe`` command available system-wide, just place a
symlink into ``/usr/local/bin``, like::

ln -s /opt/luftdatenpumpe/.venv/bin/luftdatenpumpe /usr/local/bin/luftdatenpumpe


***************
Expand All @@ -45,3 +44,4 @@ Troubleshooting
$ export PKG_CONFIG_PATH="/usr/local/opt/icu4c/lib/pkgconfig"
$ pkg-config --modversion icu-i18n
63.1

0 comments on commit afe9da5

Please sign in to comment.