Skip to content

Commit b6a69dd

Browse files
committed
docs: Include section on dependencies
Fixes #62
1 parent 659e3fc commit b6a69dd

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,26 @@ make
4242
sudo make install
4343
```
4444

45+
## Dependencies
46+
47+
Keyboard-backlightd has a couple of dependencies:
48+
49+
* Rust (build time). This can either be installed from your distro's
50+
package manager or using [rustup](https://rustup.rs/).
51+
* `libevdev` (build time and runtime, for reading input devices)
52+
53+
On some distros you may need to install a package with a name such as `libevdev-dev`
54+
or `libevdev-devel` to get the development files needed to build software using `libevdev`.
55+
56+
Additionally, you may need to install basic build tools. These are usually provided
57+
by a meta-package such as `base-devel` or `build-essential`, but refer to the
58+
documentation for your Linux distro for details. You may also need to install
59+
`pkgconf` or `pkg-config` to help the build process find the `libevdev` library.
60+
61+
The build process will fall back to building `libevdev` from source if it can't
62+
be found on your system. If so you likely need to install additional dependencies,
63+
please refer to the documentation of `libevdev`.
64+
4565
## Warning!
4666

4767
This program will monitor your key presses, but only to detect when you press
@@ -171,6 +191,7 @@ Once you have found your required command line parameters, edit
171191
`/etc/conf.d/keyboard-backlightd` to set them for use in the systemd service.
172192

173193
Then enable and start the systemd service and make sure everything still works:
194+
174195
```bash
175196
systemctl enable keyboard-backlightd
176197
systemctl start keyboard-backlightd

0 commit comments

Comments
 (0)