https://github.com/haobogu/rmk-template
Project template for RMK
https://github.com/haobogu/rmk-template
firmware keyboard rmk template
Last synced: 3 months ago
JSON representation
Project template for RMK
- Host: GitHub
- URL: https://github.com/haobogu/rmk-template
- Owner: HaoboGu
- Created: 2024-01-23T10:25:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-12-15T15:22:56.000Z (6 months ago)
- Last Synced: 2025-12-18T12:26:24.852Z (6 months ago)
- Topics: firmware, keyboard, rmk, template
- Language: Rust
- Homepage: https://github.com/HaoboGu/rmk
- Size: 557 KB
- Stars: 9
- Watchers: 1
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# rmk-template
Collections of project templates for initializing a [RMK](https://github.com/HaoboGu/rmk) keyboard firmware project.
## Usage
1. Install `rmkit` and `flip-link`
```shell
cargo install rmkit flip-link
```
2. Create your project using the template
```shell
rmkit init
```
3. Follow the steps in generated `README.md` to finish the initialization
4. (optional) Install [`probe-rs`](https://github.com/probe-rs/probe-rs) for flashing and debugging
```shell
# 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
```shell
cargo build --release
cargo run
```