Overview

This guide aims to introduce you how to build your own keyboard firmware using RMK and run it on your microcontroller. There are 3 steps of the guide:

• setup the RMK environment

• create a RMK project

• compile the firmware and flash

If you get any questions or problems following this guide, please fire an issue at https://github.com/HaoboGu/rmk/issues.

Before we start

Using RMK requires basic knowledge of Rust programming and embedded devices. If you're not familiar with Rust, The Official Rust Book is a good start. And, if you're not familiar with embedded Rust, we recommend you to read The Embedded Rust Book first. We'll keep working on making RMK more accessible for everybody.