qmk/qmk_firmware
Open-source keyboard firmware for Atmel AVR and Arm USB families
From the publisher
README & documentation
Source previewRead the project’s overview, installation instructions and usage examples. The original README is the source of truth.
[](https://github.com/qmk/qmkfirmware/tags) [](https://discord.gg/qmk) [](https://docs.qmk.fm) [](https://github.com/qmk/qmkfirmware/pulse/monthly) [](https://github.com/qmk/qmkfirmware/) This is a keyboard firmware based on the tmk\keyboard firmware with some useful features for Atmel AVR and ARM controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line. The docs are powered by VitePress. They are also viewable offline; see Previewing the Documentation for more details. You can request changes by making a fork and opening a pull request. The project also includes community support for lots of other keyboards. QMK is developed and maintained by Jack Humbert…
Read the full README ↗ · Preview checked 2026-10-27T16:14:28.761Z
Inside the original README — Document outline
Headings are captured from the source. Links open the publisher’s document, not a locally hosted copy.
Links from the README
References supplied by the publisher, not independently verified endorsements. Check the destination before downloading files or entering credentials.
Documentation belongs to its respective authors. Reported project/model license: GPL-2.0. A listing is not a grant of reuse or training rights. Confirm the document’s own terms at the source.
What this repository does
Open-source keyboard firmware for Atmel AVR and Arm USB families
Repository facts
- Owner
- qmk
- Primary language
- C
- Stars
- 20,787
- Forks
- 44,392
- Open issues + pull requests
- 572
- License
- GPL-2.0
- Archived
- No
- Default branch
- master
- Created
- 2014-12-08T22:02:05.000Z
- Last push
- 2026-10-29T16:52:08.000Z
Topics and intended use
Owner-supplied topics: atmel-avr, c, c-plus-plus, clueboard, ergodox-ez, keyboard-firmware, keyboard-support, olkb, qmk
Review the README for scope, installation, examples and limitations. We do not run repository code or certify it.
Evaluate before installing
Review licensing and dependencies, inspect recent commits and unresolved issues, and test in an isolated environment before production use. Stars and forks alone cannot answer these questions.
Source and freshness
Source: GitHub. Metadata observed 2026-10-31T18:43:23.065Z. Daily imports are snapshots, not real-time monitoring.
Popularity and source listings do not establish security, suitability, licensing rights or benchmark performance.