From 5488593caa85b8189281dcb009291479087d2899 Mon Sep 17 00:00:00 2001 From: "Peter F. Patel-Schneider" Date: Tue, 14 Sep 2021 11:28:42 -0400 Subject: [PATCH] doc: update installation instructions to mention Python versions --- docs/installation.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index 976c5e72..d7b71f4b 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -20,18 +20,21 @@ Most of Solaar should work fine with any kernel more recent than 5.2, but newer kernels might be needed for some devices to be correctly recognized and handled. The `udev` package must be installed and its daemon running. -Solaar requires Python 3.6+ and the -`python3-pyudev`, -`python3-psutil`, `python3-xlib`, and `python3-yaml` or `python3-pyyaml` packages. +Solaar requires Python 3.6+ and requires several packages to be installed. +If you are running the system version of Python you should have the +`python3-pyudev`, `python3-psutil`, `python3-xlib`, +and `python3-yaml` or `python3-pyyaml` packages installed. To run the GUI Solaar also requires Gtk3 and its GObject introspection bindings. -The Debian/Ubuntu packages that need to be installed are -`python3-gi` and `gir1.2-gtk-3.0`; -in Fedora you need `gtk3` and `python3-gobject`; -if you're using another -distribution the required packages are most likely named something similar. +If you are running the system verison of Python +the Debian/Ubuntu packages you should have +`python3-gi` and `gir1.2-gtk-3.0` installed. +in Fedora you need `gtk3` and `python3-gobject`. You may have to install `gcc` and the Python development package (`python3-dev` or `python3-devel`, depending on your distribution). +If you are running a version of Python different from the system version, +you may need to use pip to install projects that provide the above Python packages. + If desktop notifications bindings are also installed (`gir1.2-notify-0.7` for Debian/Ubuntu), you will also see desktop notifications when devices come online/go offline.