Quantum Mechanical Keyboard Firmware

This is a keyboard firmware based on the tmk_keyboard firmware(link is external) with some useful features for Atmel AVR and ARM controllers, and more specifically, the OLKB product line(link is external), the ErgoDox EZ(link is external) keyboard, and the Clueboard product line(link is external).

Documentation

• See the official documentation on docs.qmk.fm(link is external)

The docs are powered by Docsify(link is external) and hosted on GitHub. They are also viewable offline; see Previewing the Documentation(link is external) for more details.

You can request changes by making a fork and opening a pull request(link is external), or by clicking the "Edit this page" link at the bottom of any page.

Supported Keyboards

• Planck
• Preonic
• ErgoDox EZ
• Clueboard
• Cluepad
• Atreus

The project also includes community support for lots of other keyboards.

Maintainers

QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, Hasu(link is external). The OLKB product firmwares are maintained by Jack Humbert(link is external), the Ergodox EZ by ZSA Technology Labs(link is external), the Clueboard by Zach White(link is external), and the Atreus by Phil Hagelberg(link is external).

Official Website

qmk.fm(link is external) is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.