Skip to content

docs: per-distribution install steps, and state that this is Linux only - #6

Merged
mateusands merged 1 commit into
mainfrom
docs/install-per-distro
Aug 8, 2026
Merged

mateusands merged 1 commit into
mainfrom
docs/install-per-distro

Conversation

@mateusands

Copy link
Copy Markdown
Owner

Copy-paste install blocks for Arch, Debian/Ubuntu, Fedora and openSUSE, plus a universal pip fallback, and the tkinter gotcha on Debian (python3-tk is not installed with Python there).

macOS instructions were requested and are deliberately absent: the driver reads /sys/class/hidraw/, opens /dev/hidraw* and uses the HIDIOCSFEATURE ioctl — Linux kernel interfaces with no macOS equivalent. A port needs a second backend over IOKit or hidapi. The README now says so, and points at the three functions that would have to be reimplemented, instead of sending people down a dead end.

🤖 Generated with Claude Code

…nux only

Adds copy-paste install blocks for Arch, Debian/Ubuntu, Fedora and openSUSE,
plus a universal pip fallback. They install the optional Qt interface from the
distribution rather than pip, which tends to match the system theme better; the
core still needs nothing.

Also notes the tkinter gotcha: Debian and Ubuntu do not ship tkinter with Python,
so the fallback interface needs python3-tk.

A macOS section was requested and is deliberately absent. The driver reads
/sys/class/hidraw/, opens /dev/hidraw* and uses the HIDIOCSFEATURE ioctl — all
Linux kernel interfaces. macOS exposes HID through IOKit and has no hidraw, so a
port means a second backend for core/device.py, most likely over hidapi, which
would cost the core its zero-dependency property. Writing install instructions
for a platform where nothing can work would only waste people's time, so the
README says why instead, and points at the three functions that would have to be
reimplemented.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@mateusands
mateusands merged commit aa88d69 into main Aug 8, 2026
14 checks passed
@mateusands
mateusands deleted the docs/install-per-distro branch August 8, 2026 19:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant