zmk/docs/docs/intro.md

id, title, sidebar_label

id	title	sidebar_label
intro	Introduction to ZMK	Introduction

ZMK Firmware is an open source (MIT) keyboard firmware built on the Zephyr™ Project Real Time Operating System (RTOS).

The goal is to provide a powerful, featureful keyboard firmware that is free of licensing issues that prevent upstream BLE support as a first-class feature.

Features

At this point, ZMK is still missing many features compared to popular firmware such as QMK. Here is a table comparing supported ZMK and QMK features:

Feature	ZMK	QMK
Multi-Device BLE Support	✅
USB Connectivity	✅	✅
User Configuration Repositories	✅
Split Keyboard Support	✅	✅
Keymaps and Layers	✅	✅
Hold-Tap (Which Includes Mod-Tap and Layer-Tap)	✅	✅
Basic Keycodes	✅	✅
Basic consumer (Media) Keycodes	✅	✅
Encoders1	✅	✅
OLED Display Support2	In Dev	✅
RGB Underglow	✅	✅
One Shot Keys	In Dev	✅
Combo Keys	In Dev	✅
Macros	In Dev	✅
Mouse Keys		✅
Low Active Power Usage	✅
Low Power Sleep States	In Dev
Low Power Mode (VCC Shutoff)	In Dev
Battery Reporting	In Dev
Shell over BLE
Realtime Keymap Updating	Planned	✅
AVR/8 Bit		✅
Wide Range of ARM Chips Supported	✅

Code Of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

---

1. OLEDs are currently proof of concept in ZMK. ↩︎

2. Encoders are not currently supported on peripheral side splits. ↩︎