Skip to content

Files

Latest commit

dc92b9a · Jan 23, 2025

History

History
This branch is 507 commits behind HaoboGu/rmk:main.

examples

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Jan 23, 2025
Jan 23, 2025
May 10, 2024

RMK Examples

RMK provides two ways to create your firmware:

  1. Create a keyboard.toml and then uses #[rmk_keyboard] macro, see examples/use_config

  2. Write your own firmware using RMK API, see examples/use_rust

The toml configuration + macro way is super easy to use, everything is configured in keyboard.toml, no Rust code required.

The second way suits for people who want flexibility and extendability and are comfortable writing Rust code.

RMK provides examples for both way, check out the use_config and use_rust folder in examples.