aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKimplul <kimi.h.kuparinen@gmail.com>2020-06-12 15:11:45 +0300
committerGitHub <noreply@github.com>2020-06-12 15:11:45 +0300
commit3e2342e69d11d5f938fd3c7800a9eb761a5e9375 (patch)
tree623051973ab9c3f2746f4652b9790313c68ef1da /README.md
parent75560062fc8f188ebd2a9a53568f99556e593355 (diff)
downloadhid-tmff2-3e2342e69d11d5f938fd3c7800a9eb761a5e9375.tar.gz
hid-tmff2-3e2342e69d11d5f938fd3c7800a9eb761a5e9375.zip
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index 6f5d0be..8668174 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,14 @@
-Linux kernel module for the Thrustmaster T300RS wheel
+# Linux kernel module for the Thrustmaster T300RS wheel
+
+## General information for the curious:
+* This driver is heavily under development, and is currently missing some major features, such as force feedback among many other things.
+
+* I try to only push to Github whenever I'm relatively sure the driver won't freeze up the kernel, but I absolutely do not recommend running this driver on your main computer. Set up a virtual machine if you want to test this out. I personally recommend QEMU/libvirt: https://www.qemu.org/download/
+
+* In case you want to try installing this driver, it should be fairly simple:
+ ```
+ make
+ sudo make install
+ ```
+ And possibly some ```sudo depmod -a && sudo modprobe hid-tmff2```
+ To see if the driver is being loaded, run ```dmesg```. The feed should be filled with debugging messages that honestly probably should be improved. A lot.