Skip to content

Commit

Permalink
Merge pull request #25 from FrameworkComputer/readme
Browse files Browse the repository at this point in the history
README: Add linux udev instructions
  • Loading branch information
JohnAZoidberg authored Oct 25, 2023
2 parents 50a4119 + 0681f5b commit 3679a23
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,23 @@ qmk_hid via --rgb-effect 38
## Building from source
Pre-requisites: Rust, libudev
Pre-requisites:
- [Rust](https://rustup.rs/)
- libudev (`libudev-dev` on Ubuntu, `systemd-devel` on Fedora)
```sh
# Directly run
cargo run
# Build and run executable (on Linux)
cargo build
ls -l target/debug/qmk_hid
./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.

0 comments on commit 3679a23

Please sign in to comment.