From 66eaa9eaa13df4c8021d1c0e06899c669ba81f0a Mon Sep 17 00:00:00 2001 From: Daniel Schaefer Date: Tue, 24 Oct 2023 05:39:38 -0400 Subject: [PATCH] README: Add linux udev instructions Signed-off-by: Daniel Schaefer --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 398487c..89a1eab 100644 --- a/README.md +++ b/README.md @@ -187,9 +187,19 @@ qmk_hid via --rgb-effect 38 ## Building from source -Pre-requisites: Rust, libudev +Pre-requisites: + +- [Rust](https://rustup.rs/) +- libudev ```sh cargo build ls -l target/debug/qmk_hid ``` + +# Running on Linux + +To avoid needing root privileges to access the keyboard please follow the +official [QMK guide](https://docs.qmk.fm/#/faq_build?id=linux-udev-rules) for +how to install udev rules. After doing that, you'll be able to interact with +the keyboards as a regular user.