Skip to content

Commit 3679a23

Browse files
Merge pull request #25 from FrameworkComputer/readme
README: Add linux udev instructions
2 parents 50a4119 + 0681f5b commit 3679a23

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -187,9 +187,23 @@ qmk_hid via --rgb-effect 38
187187
188188
## Building from source
189189
190-
Pre-requisites: Rust, libudev
190+
Pre-requisites:
191+
192+
- [Rust](https://rustup.rs/)
193+
- libudev (`libudev-dev` on Ubuntu, `systemd-devel` on Fedora)
191194
192195
```sh
196+
# Directly run
197+
cargo run
198+
199+
# Build and run executable (on Linux)
193200
cargo build
194-
ls -l target/debug/qmk_hid
201+
./target/debug/qmk_hid
195202
```
203+
204+
## Running on Linux
205+
206+
To avoid needing root privileges to access the keyboard please follow the
207+
official [QMK guide](https://docs.qmk.fm/#/faq_build?id=linux-udev-rules) for
208+
how to install udev rules. After doing that, you'll be able to interact with
209+
the keyboards as a regular user.

0 commit comments

Comments
 (0)