20.8K ·GitHub
What is this?
QMK is an open-source keyboard firmware based on tmk_keyboard, adding features for Atmel AVR and ARM controllers. It is best known for the OLKB product line, the ErgoDox EZ and Clueboard keyboards.
QMK is an open-source keyboard firmware based on tmk_keyboard, adding features for Atmel AVR and ARM controllers. It is best known for the OLKB product line, the ErgoDox EZ and Clueboard keyboards.Does this run on the keyboard itself, or on my computer?On the keyboard itself — QMK is firmware that lives on the board's Atmel AVR or ARM controller. Your computer just sees a regular USB keyboard.
On the keyboard itself — QMK is firmware that lives on the board's Atmel AVR or ARM controller. Your computer just sees a regular USB keyboard.How do I get it onto my keyboard?The README points to the official documentation at docs.qmk.fm — setup, building and flashing instructions live there.
The README points to the official documentation at docs.qmk.fm — setup, building and flashing instructions live there.What do I need on my computer to build it?The firmware itself is written in C for AVR and ARM chips, and the repository also ships Python-based tooling for working with it.
The firmware itself is written in C for AVR and ARM chips, and the repository also ships Python-based tooling for working with it.Which keyboards does it support out of the box?OLKB's Planck and Preonic, the ErgoDox EZ, Clueboard's boards and the Cluepad, plus the Atreus — and community support for many other boards beyond those.
OLKB's Planck and Preonic, the ErgoDox EZ, Clueboard's boards and the Cluepad, plus the Atreus — and community support for many other boards beyond those.Can I read the documentation offline?Yes — the docs on docs.qmk.fm are powered by VitePress and are viewable offline; the README points to a page on previewing them.
Yes — the docs on docs.qmk.fm are powered by VitePress and are viewable offline; the README points to a page on previewing them.What does QMK stand for?Quantum Mechanical Keyboard. It extends Hasu's tmk_keyboard firmware and is developed and maintained by Jack Humbert of OLKB with community contributions.
Quantum Mechanical Keyboard. It extends Hasu's tmk_keyboard firmware and is developed and maintained by Jack Humbert of OLKB with community contributions.How can I check whether my own keyboard model is supported?The official site qmk.fm links to the full list of keyboards supported by QMK, alongside the documentation and this repository.
The official site qmk.fm links to the full list of keyboards supported by QMK, alongside the documentation and this repository.Can boards beyond the official ones run QMK?Yes — beyond the official line-up the project includes community support for lots of other keyboards, and changes or additions are made by forking the repo and opening a pull request.
Yes — beyond the official line-up the project includes community support for lots of other keyboards, and changes or additions are made by forking the repo and opening a pull request.What are similar projects?Keychron-Keyboards-Hardware-Design, micropython, amlogic-s9xxx-armbian, Marlin, frank-386, mu300-linux, mozc-devices, Reverse-Engineering
Keychron-Keyboards-Hardware-Design, micropython, amlogic-s9xxx-armbian, Marlin, frank-386, mu300-linux, mozc-devices, Reverse-EngineeringWhich topics is it in?arm, keyboard, c-plus-plus, firmware, gplv2, embedded, hardware, c, cpp, documentation, python, cross-platform
arm, keyboard, c-plus-plus, firmware, gplv2, embedded, hardware, c, cpp, documentation, python, cross-platform