From: Andrew Sichevoi <k@thekondor.net>
Date: Sun, 24 Jan 2021 08:39:05 +0000 (+0100)
Subject: readme: initial version
X-Git-Tag: v0.0.1~1
X-Git-Url: http://git.thekondor.net/?a=commitdiff_plain;h=5001dc3620302a089e775a809e4a77a6fc4f49b0;p=reset-trackpoint-fix.git

readme: initial version
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5b24bf1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# reset-trackpoint-fix (thinkpad)
+
+The script addresses a dead trackpoint/trackpad accordingly to [wiki page](https://wiki.archlinux.org/index.php/Lenovo_ThinkPad_X1_Carbon_(Gen_6)#TrackPoint_and_Touchpad_issues) by disconnecting and reconnecting a broken SerIO device on resume.
+
+## Configuration
+
+- Uncomment and set a proper value in `/etc/reset-trackpoint-fix.conf`. Usually it is equal to `serio1`.
+
+- Enable `systemctl enable /etc/systemd/system/reset-trackpoint-fix.service`
+
+
+## Files
+
+**aka** installation locations:
+
+- `/usr/bin/reset-trackpoint-fix.sh`
+
+- `/etc/reset-trackpoint-fix.conf`
+
+- `/etc/systemd/system/reset-trackpoint-fix.service`