RomanNum3ral
/
Solaar
mirror of https://github.com/pwr-Solaar/Solaar.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: update installation instructions to mention Python versions

This commit is contained in:
Peter F. Patel-Schneider 2021-09-14 11:28:42 -04:00
parent 338a2687d3
commit 5488593caa
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/installation.md
View File

@ -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. 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. The `udev` package must be installed and its daemon running.
Solaar requires Python 3.6+ and the Solaar requires Python 3.6+ and requires several packages to be installed.
`python3-pyudev`, If you are running the system version of Python you should have the
`python3-psutil`, `python3-xlib`, and `python3-yaml` or `python3-pyyaml` packages. `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. To run the GUI Solaar also requires Gtk3 and its GObject introspection bindings.
The Debian/Ubuntu packages that need to be installed are If you are running the system verison of Python
`python3-gi` and `gir1.2-gtk-3.0`; the Debian/Ubuntu packages you should have
in Fedora you need `gtk3` and `python3-gobject`; `python3-gi` and `gir1.2-gtk-3.0` installed.
if you're using another in Fedora you need `gtk3` and `python3-gobject`.
distribution the required packages are most likely named something similar.
You may have to install `gcc` and the Python development package (`python3-dev` or `python3-devel`, You may have to install `gcc` and the Python development package (`python3-dev` or `python3-devel`,
depending on your distribution). 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 If desktop notifications bindings are also installed
(`gir1.2-notify-0.7` for Debian/Ubuntu), (`gir1.2-notify-0.7` for Debian/Ubuntu),
you will also see desktop notifications when devices come online/go offline. you will also see desktop notifications when devices come online/go offline.