docs: update cloning instruction to also clone submodule

This commit is contained in:
Peter F. Patel-Schneider 2022-10-11 09:09:34 -04:00
parent 2462d1aad7
commit cb22bc63e1
1 changed files with 2 additions and 4 deletions

View File

@ -7,7 +7,8 @@ layout: page
## Downloading
Clone Solaar from GitHub by `git clone https://github.com/pwr-Solaar/Solaar.git`
Clone Solaar from GitHub by `git clone --recurse-submodules https://github.com/pwr-Solaar/Solaar.git`
Solaar has a submodule, so make sure that the submodule is cloned.
## Requirements for Solaar
@ -32,9 +33,6 @@ 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).
Solaar also uses the hidtools library from the Python hid-tools project.
To install this library use `pip install --user hid-tools`.
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.