README: Add linux udev instructions #25
Merged
Conversation
This file contains 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
zachfeldman
reviewed
Oct 24, 2023
README.md
Outdated
| Pre-requisites: | ||
|
|
||
| - [Rust](https://rustup.rs/) | ||
| - libudev |
There was a problem hiding this comment.
Nice! You might want to mention that the libudev apt is usually available at libudev-dev or just say (most systems: sudo apt install libudev-dev.
There was a problem hiding this comment.
I was thinking about that. But then I was running fedora and it's called something else there...
There was a problem hiding this comment.
I added it actually now ;)
There was a problem hiding this comment.
Sweet, I like that you added instructions for our two most popular distros!
zachfeldman
approved these changes
Oct 24, 2023
| Pre-requisites: | ||
|
|
||
| - [Rust](https://rustup.rs/) | ||
| - libudev | ||
|
|
||
| ```sh | ||
| cargo build |
There was a problem hiding this comment.
This did indeed work! It might be better to tell folks how to run it after they build it. Instead of the ls -l, ./target/debug/qmk_hid.
zach@zach-lotus:~/dev/qmk_hid (main)$ cargo build
Updating crates.io index
Downloaded anstyle v1.0.1
Downloaded anstyle-parse v0.2.1
Downloaded once_cell v1.18.0
Downloaded quote v1.0.29
Downloaded clap_derive v4.3.2
Downloaded anstream v0.3.2
Downloaded clap v4.3.9
Downloaded proc-macro2 v1.0.63
Downloaded clap_builder v4.3.9
Downloaded syn v2.0.22
Downloaded hidapi v2.3.3
Downloaded libc v0.2.147
Downloaded 12 crates (1.7 MB) in 0.33s
Compiling libc v0.2.147
Compiling io-lifetimes v1.0.11
Compiling rustix v0.37.20
Compiling proc-macro2 v1.0.63
Compiling bitflags v1.3.2
Compiling unicode-ident v1.0.9
Compiling quote v1.0.29
Compiling linux-raw-sys v0.3.8
Compiling pkg-config v0.3.27
Compiling cc v1.0.79
Compiling utf8parse v0.2.1
Compiling anstyle v1.0.1
Compiling anstyle-query v1.0.0
Compiling colorchoice v1.0.0
Compiling static_vcruntime v2.0.0
Compiling clap_lex v0.5.0
Compiling strsim v0.10.0
Compiling anstyle-parse v0.2.1
Compiling heck v0.4.1
Compiling once_cell v1.18.0
Compiling qmk_hid v0.1.11 (/home/zach/dev/qmk_hid)
Compiling hidapi v2.3.3
Compiling syn v2.0.22
Compiling is-terminal v0.4.7
Compiling anstream v0.3.2
Compiling clap_builder v4.3.9
Compiling clap_derive v4.3.2
Compiling clap v4.3.9
Finished dev [unoptimized + debuginfo] target(s) in 4.44s
zach@zach-lotus:~/dev/qmk_hid (main)$ ls -l target/debug/qmk_hid
-rwxrwxr-x 2 zach zach 20062248 Oct 24 09:17 target/debug/qmk_hid
zach@zach-lotus:~/dev/qmk_hid (main)$ ls target/debug/qmk_hid
target/debug/qmk_hid
zach@zach-lotus:~/dev/qmk_hid (main)$ ./target/debug/qmk_hid
RAW HID and VIA commandline for QMK devices
Usage: qmk_hid [OPTIONS] [COMMAND]
Commands:
factory Factory
via Via
qmk QMK
help Print this message or the help of the given subcommand(s)
Options:
-l, --list List connected HID devices
-v, --verbose Verbose outputs to the console
--vid <VID> VID (Vendor ID) in hex digits
--pid <PID> PID (Product ID) in hex digits
-h, --help Print help
-V, --version Print version
zach@zach-lotus:~/dev/qmk_hid (main)$ ./target/debug/qmk_hid -l
32ac:0012
Manufacturer: "Framework"
Product: "Laptop 16 Keyboard Module - ANSI"
FW Version: 0.2.3
Serial No: "FRAKDKEN0100000000"
There was a problem hiding this comment.
That's a good idea, yeah
Signed-off-by: Daniel Schaefer <[email protected]>
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.
No description provided.