From f2acc8db6b7eb1f93303a00dd2b1899067b81956 Mon Sep 17 00:00:00 2001 From: historia Date: Sun, 6 Sep 2026 14:09:42 -0400 Subject: readme --- README.md | 21 --------------------- 1 file changed, 21 deletions(-) diff --git a/README.md b/README.md index 3f16465..22d4bde 100644 --- a/README.md +++ b/README.md @@ -27,24 +27,3 @@ Log out/in, then run the script. | `-v`, `--verbose` | log key presses/releases, RMB injection, measured motion rate | | `--test-rmb [SECONDS]` | self-test: hold the injected RMB for `SECONDS` (default 3) and read events back from the kernel; no keyboard needed | | `--check` | show detected keyboards, uinput and grab status, then exit | - - -## Setup on Arch (KDE Wayland / X11 alike) - -1. Your user needs to read the keyboard event devices and, on Arch, that same - group membership also grants write access to `/dev/uinput`: - - ``` - sudo usermod -aG input $USER # log out and back in afterwards - ``` - (Arch autoloads the `uinput` module on first open; no udev rules needed.) -2. The script auto-creates `.venv` and installs `evdev` on first run — no - extra steps. -3. Run `./vrising-cam.py --check` — it should print `READY`: - `/dev/uinput` openable, your keyboards listed exposing Q+E, and no - "exclusively grabbed" warnings. - -Troubleshooting when something does fail — the script prints a targeted hint: -`/dev/uinput` unwritable (rare on Arch; sudo or a udev rule fixes it), module -missing (`modprobe uinput` then add it to `/etc/modules-load.d/`), or -keyboards unreadable (the `input` group again). -- cgit v1.2.3