Skip to content

HaoboGu/rmk-template

Repository files navigation

rmk-template

Template for initializing a RMK keyboard firmware project.

Usage

  1. Install cargo generate

    cargo install cargo-generate
  2. Create your project using the template

    cargo generate --git https://github.com/HaoboGu/rmk-template
  3. Follow the steps in generated README.md to finish the initialization

  4. (optional) Install probe-rs for flashing and debugging

    cargo install probe-rs --features cli
  5. (optional) Build and flash

    cargo build --release
    cargo run