readme.md (2298B)
- # Quantum Mechanical Keyboard Firmware
- [](https://github.com/qmk/qmk_firmware/tags)
- [](https://discord.gg/qmk)
- [](https://docs.qmk.fm)
- [](https://github.com/qmk/qmk_firmware/pulse/monthly)
- [](https://github.com/qmk/qmk_firmware/)
- This is a keyboard firmware based on the [tmk\_keyboard firmware](https://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR and ARM controllers, and more specifically, the [OLKB product line](https://olkb.com), the [ErgoDox EZ](https://ergodox-ez.com) keyboard, and the Clueboard product line.
- ## Documentation
- * [See the official documentation on docs.qmk.fm](https://docs.qmk.fm)
- The docs are powered by [VitePress](https://vitepress.dev/). They are also viewable offline; see [Previewing the Documentation](https://docs.qmk.fm/#/contributing?id=previewing-the-documentation) for more details.
- You can request changes by making a fork and opening a [pull request](https://github.com/qmk/qmk_firmware/pulls).
- ## Supported Keyboards
- * [Planck](/keyboards/planck/)
- * [Preonic](/keyboards/preonic/)
- * [ErgoDox EZ](/keyboards/ergodox_ez/)
- * [Clueboard](/keyboards/clueboard/)
- * [Cluepad](/keyboards/clueboard/17/)
- * [Atreus](/keyboards/atreus/)
- The project also includes community support for [lots of other keyboards](/keyboards/).
- ## Maintainers
- QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, [Hasu](https://github.com/tmk). The OLKB product firmwares are maintained by [Jack Humbert](https://github.com/jackhumbert), the Ergodox EZ by [ZSA Technology Labs](https://github.com/zsa), the Clueboard by [Zach White](https://github.com/skullydazed), and the Atreus by [Phil Hagelberg](https://github.com/technomancy).
- ## Official Website
- [qmk.fm](https://qmk.fm) is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.