rmk-template

Template for initializing a RMK keyboard firmware project.

Usage

1. Install cargo generate and flip-link

   cargo install cargo-generate flip-link

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

   # 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

5. (optional) Build and flash

   cargo build --release
   cargo run