diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..bad48e5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 Bohdan Pavuk + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e71d16f --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# touche driver + +## Setup + +Ensure `libevdev-dev` and `libudev-dev` are installed: + +### Ubuntu +```bash +sudo apt-get update && sudo apt-get install libevdev-dev systemd-dev +``` + +### Fedora +```bash +sudo dnf install libevdev-devel +``` + +### Arch +``` +# Install yay or another AUR helper first. + +# Install libudev0 from AUR +yay -S libudev0 +sudo pacman -S libevdev +``` + +### NixOS +Under construction! + +## Run +Sometimes, the driver may not see the device because it lacks bundled `udev` rules. +The problem is, there are so-o-o many device manufacturers and lineups, and each has +different device/manufacturer IDs, so it's usually simpler to run the binary as root +(with `sudo`). + +Grab the binary [here](https://github.com/bpavuk/touche-driver/releases/latest)