diff options
| author | Jack & Erez <jack.humb@gmail.com> | 2016-06-22 23:24:47 -0400 |
|---|---|---|
| committer | Erez Zukerman <ezuk@madmimi.com> | 2016-06-22 23:24:47 -0400 |
| commit | 7e584439ee613fe156b15ebe8b85d921770861ca (patch) | |
| tree | 30d7cad7e5deca991128085002355d0fe452848e | |
| parent | 2443234555e3b69ba51d0a62fbf3faba09b95680 (diff) | |
Updates overall readme
| -rw-r--r-- | README.md | 18 | ||||
| -rw-r--r-- | keyboards/readme.md | 1 |
2 files changed, 18 insertions, 1 deletions
@@ -4,6 +4,24 @@ This is a keyboard firmware based on the [tmk_keyboard firmware](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR controllers, and more specifically, the [OLKB product line](http://olkb.co), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). +## Official website + +For an easy-to-read version of this document and the repository, check out [http://qmk.fm](http://qmk.fm). + +## Included Keyboards + +* [Planck](/keyboards/planck/) +* [Preonic](/keyboards/preonic/) +* [Atomic](/keyboards/atomic/) +* [ErgoDox EZ](/keyboards/ergodox_ez/) +* [Clueboard rev.1](/keyboards/clueboard1/) +* [Clueboard rev.2](/keyboards/clueboard2/) +* [Cluepad](/keyboards/cluepad/) + +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, TMK. In fact, this repo used to be a fork of TMK, and we are incredibly grateful for his founding contributions to the firmware. We've had to break the fork due to purely technical reasons -- it simply became too different over time, and we've had to start refactoring some of the basic bits and pieces. We are huge fans of TMK, both the firmware and the person. :) This documentation is edited and maintained by Erez Zukerman of ErgoDox EZ. If you spot any typos or inaccuracies, please [open an issue](https://github.com/jackhumbert/qmk_firmware/issues/new). diff --git a/keyboards/readme.md b/keyboards/readme.md index 6f16efe49a..b2173f6ebb 100644 --- a/keyboards/readme.md +++ b/keyboards/readme.md @@ -1,5 +1,4 @@ # Included Keyboards - QMK runs on a diverse range of keyboards. Some of these keyboards are officially supported and see constant community contributions, while others are part of the repository for historical reasons. ## Official QMK Keyboards |