add instructionsHEADmaster

1 files changed, 14 insertions, 11 deletions

diff --git a/README b/README
index e046aa0..7b6bca7 100644
--- a/README
+++ b/README
@@ -6,22 +6,25 @@ keyboard backlight daemon for the cat s22
 no warranty. if it blows up or starts screaming in latin, call a priest and
 leave me out of it.
 
-roadmap
--------
-
-[x] finish refactor
-  (x) separate code into multiple files
-  (x) config.h with consts
+how to use
+----------
+1. install armv7 gnu crosscompiler. ask jeeves...
+2. edit src/config.h:
+	DEBOUNCE & THREAD_WAIT are extraneous. ignore them or have fun.
 
-[x] signals for ipc
+	BACKLIGHT_TIME is to be set to the time for which the backlight should be on
+	after a keypress. use SEC for seconds, MS for milliseconds, or no unit
+	(microseconds).
 
-[x] magisk module
+	KEYBOARD_FILE is to be set to the devfs file used for the keypad's evdev.
 
-[n] enable on lid-open (fuck polling)
+	BACKLIGHT_FILE is to be set to the sysfs file used for the keypad's light.
 
-[ ] config file in /data/???
+	MAX_BRIGHTNESS should be self explanatory.
 
-[ ] handle press, hold, & release
+	if IGNORE_RELEASE is set to 1, only press events will trigger the backlight
+	timer. otherwise, all events (press, hold, and release) will trigger the
+	timer.
 
 license
 -------