logologo
Guide
Documentation
API doc
main
v0.8
v0.7.8
Guide
Documentation
API doc
main
v0.8
v0.7.8
logologo

Getting Started

Introduction
Supported Hardwares
Real World Examples
FAQ

User Guide

Guide Overview

Creating Firmware

Cloud compilation
Local compilation
Flashing Firmware

Migration Guide

From v0.6 to v0.7
From v0.7 to v0.8

Features

Matrix
Layers
Wireless
Configuration
Low Power
Split keyboard
Vial support
USB Logging
Storage
Use Rust
Controller Support
Input Device
Binary size

Configuration

Keyboard Device
Keyboard Matrix
Layout

Keymap Configuration

Keyboard Macros
Keycodes
Special Characters and Unicode
Special Keys
Light
Behavior
Split keyboard
Wireless/Bluetooth
Storage
Host Configuration
RMK Internal Configuration

Input Device

Rotary encoders
Joysticks
Appendix

Development

Contributing
Roadmap

Guide Overview#

Welcome to RMK! This comprehensive guide will walk you through building custom keyboard firmware using RMK and deploying it to your microcontroller.

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

Previous PageFAQ
Next PageCreating Firmware