Repository navigation
docs: per-distribution install steps, and state that this is Linux only - #6
Merged
Merged
Conversation
…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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Copy-paste install blocks for Arch, Debian/Ubuntu, Fedora and openSUSE, plus a universal pip fallback, and the tkinter gotcha on Debian (
python3-tkis not installed with Python there).macOS instructions were requested and are deliberately absent: the driver reads
/sys/class/hidraw/, opens/dev/hidraw*and uses theHIDIOCSFEATUREioctl — 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