qmk_firmware/readme.md

36 lines
2.3 KiB
Markdown
Raw Normal View History

# Quantum Mechanical Keyboard Firmware
2017-08-03 11:57:18 -04:00
[![Current Version](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags)
2017-05-20 12:37:31 -04:00
[![Build Status](https://travis-ci.org/qmk/qmk_firmware.svg?branch=master)](https://travis-ci.org/qmk/qmk_firmware)
2018-05-03 15:56:10 -04:00
[![Discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh)
2017-05-20 12:37:31 -04:00
[![Docs Status](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm)
[![GitHub contributors](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly)
[![GitHub forks](https://img.shields.io/github/forks/qmk/qmk_firmware.svg?style=social&label=Fork)](https://github.com/qmk/qmk_firmware/)
2016-06-22 14:30:47 -04:00
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).
2015-10-28 13:58:21 -04:00
2018-04-24 12:37:52 -04:00
## Documentation
2016-06-22 23:24:47 -04:00
2018-04-24 12:37:52 -04:00
* [See the official documentation on docs.qmk.fm](https://docs.qmk.fm)
The docs are powered by [Docsify](https://docsify.js.org/) and hosted on [GitHub](/docs/). You can request changes by making a fork and [pull request](https://github.com/qmk/qmk_firmware/pulls), or by clicking the "Edit Document" link at the bottom of any page.
2016-06-22 23:24:47 -04:00
2017-05-20 12:37:31 -04:00
## Supported Keyboards
2016-06-22 23:24:47 -04:00
* [Planck](/keyboards/planck/)
* [Preonic](/keyboards/preonic/)
2017-08-24 13:17:31 +02:00
* [ErgoDox EZ](/keyboards/ergodox_ez/)
* [Clueboard](/keyboards/clueboard/)
* [Cluepad](/keyboards/clueboard/17/)
2018-08-16 08:47:36 -07:00
* [Atreus](/keyboards/atreus/)
2016-06-22 23:24:47 -04:00
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.