From d896a8b2524836dfa1225c052fe692e1276091dd Mon Sep 17 00:00:00 2001 From: Jakob Kaivo Date: Sat, 1 Oct 2016 15:59:09 -0400 Subject: update to reflect new C program replacing shell script --- README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8ca9562..66e6390 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,18 @@ -This is a simple shell script that monitors the Linux IIO acceleromter for -device rotation, then rotates the screen and touch inputs accordingly. It was -developed and tested on a ThinkPad Yoga 12 (2nd generation). +This is a program to run in the background and automatically rotate your X +screen for you. It has been developed on a ThinkPad Yoga 12. + +It monitors IIO events via ACPI to watch for the screen being folded back, at +which point rotation is enabled. When the computer is in laptop mode, rotation +doesn't occur. It also honors pressing the screen orientation lock button on +the side of the Yoga. + +It currently has hacks calling external programs to rotate the touchscreen +input and Wacom digitizer to match the orientation of the screen. A future +release will do these operations directly from the C code, removing the +external dependencies on xinput and xsetwacom. + +This program requires libXrandr to compile to and run. On Debian, you can +install this with "sudo apt install -y libxrand-dev". + +This is a very early version and is bound to have bugs. Bug reports are welcome +on GitHub. -- cgit v1.2.1