aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index aed55df..f296b56 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,16 @@ With that in mind,
## Installation
-### Manual
+### Dependencies
+
+Kernel modules require kernel headers to be installed.
+
++ Debian-based: `apt install linux-headers-$(uname -m)` (typically `linux-headers-x86_64`
++ Arch-based: `pacman -S linux-headers`
++ Fedora-based: `yum install kernel-devel kernel-headers`
+
+
+### Manual installation
+ Unplug wheel from computer
+ `git clone --recurse-submodules https://github.com/Kimplul/hid-tmff2.git`
@@ -28,6 +37,8 @@ With that in mind,
Done!
+> Note: On some systems, you will get an error/warning about SSL. This is normal for unsigned modules. For info on signing modules yourself (completely optional), see [here](https://www.kernel.org/doc/html/latest/admin-guide/module-signing.html?highlight=module%20signing).
+
### DKMS
+ Unplug wheel from computer