zmk_mf68/docs/docs/intro.md
Dom H 6308ab9426 fix(docs): Ensure relative links always resolve
Linking to the document _file path_ rather than the document _URL_
ensures that the link resolves regardless of trailing slash config.

More information is at https://docusaurus.io/docs/docs-markdown-features
2022-04-18 22:48:53 -05:00

5.4 KiB

title sidebar_label slug
Introduction to ZMK Introduction /

ZMK Firmware is an open source (MIT) keyboard firmware built on the Zephyr™ Project Real Time Operating System (RTOS). ZMK's goal is to provide a modern, wireless, and powerful firmware free of licensing issues.

Features

ZMK is currently missing some features found in other popular firmware. This table compares the features supported by ZMK, BlueMicro and QMK:

Legend: Supported 🚧 Under Development 💡 Planned
Feature ZMK BlueMicro QMK
Low Latency BLE Support
Multi-Device BLE Support
USB Connectivity
User Configuration Repositories
Split Keyboard Support
Keymaps and Layers
Hold-Tap (which includes Mod-Tap and Layer-Tap)
Tap-Dance 1
Keyboard Codes
Media & Consumer Codes
Encoders2
Display Support3 🚧 🚧
RGB Underglow
Backlight
One Shot Keys
Combo Keys
Macros
Mouse Keys 🚧
Low Active Power Usage
Low Power Sleep States
Low Power Mode (VCC Shutoff)
Battery Reporting
Shell over BLE 💡
Realtime Keymap Updating 💡
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. Tap-Dances are limited to single and double-tap on BlueMicro ↩︎

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

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