| 1 | # Quantum Mechanical Keyboard Firmware |
| 2 | |
| 3 | [![Current Version](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags) |
| 4 | [![Build Status](https://travis-ci.org/qmk/qmk_firmware.svg?branch=master)](https://travis-ci.org/qmk/qmk_firmware) |
| 5 | [![Discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh) |
| 6 | [![Docs Status](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm) |
| 7 | [![GitHub contributors](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly) |
| 8 | [![GitHub forks](https://img.shields.io/github/forks/qmk/qmk_firmware.svg?style=social&label=Fork)](https://github.com/qmk/qmk_firmware/) |
| 9 | |
| 10 | 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](https://clueboard.co). |
| 11 | |
| 12 | ## Documentation |
| 13 | |
| 14 | * [See the official documentation on docs.qmk.fm](https://docs.qmk.fm) |
| 15 | |
| 16 | The docs are hosted on [Gitbook](https://www.gitbook.com/book/qmk/firmware/details) and [GitHub](/docs/) (they are synced). You can request changes by making a fork and [pull request](https://github.com/qmk/qmk_firmware/pulls), or by clicking the "suggest an edit" link on any page of the docs. |
| 17 | |
| 18 | ## Supported Keyboards |
| 19 | |
| 20 | * [Planck](/keyboards/planck/) |
| 21 | * [Preonic](/keyboards/preonic/) |
| 22 | * [ErgoDox EZ](/keyboards/ergodox_ez/) |
| 23 | * [Clueboard](/keyboards/clueboard/) |
| 24 | * [Cluepad](/keyboards/clueboard/17/) |
| 25 | * [Atreus](/keyboards/atreus/) |
| 26 | |
| 27 | The project also includes community support for [lots of other keyboards](/keyboards/). |
| 28 | |
| 29 | ## Maintainers |
| 30 | |
| 31 | 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). |
| 32 | |
| 33 | ## Official Website |
| 34 | |
| 35 | [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. |