Template for initializing a RMK keyboard firmware project.
-
Install
cargo generateandflip-linkcargo install cargo-generate flip-link
-
Create your project using the template
cargo generate --git https://github.com/HaoboGu/rmk-template
-
Follow the steps in generated
README.mdto finish the initialization -
(optional) Install
probe-rsfor flashing and debugging# https://probe.rs/docs/getting-started/installation/ # Linux or macOS curl --proto '=https' --tlsv1.2 -LsSf https://github.com/probe-rs/probe-rs/releases/latest/download/probe-rs-tools-installer.sh | sh # Windows irm https://github.com/probe-rs/probe-rs/releases/latest/download/probe-rs-tools-installer.ps1 | iex
-
(optional) Build and flash
cargo build --release cargo run