diff options
| author | Jack & Erez <jack.humb@gmail.com> | 2016-06-22 23:17:15 -0400 |
|---|---|---|
| committer | Erez Zukerman <ezuk@madmimi.com> | 2016-06-22 23:17:15 -0400 |
| commit | 2443234555e3b69ba51d0a62fbf3faba09b95680 (patch) | |
| tree | 842338207b423118f1d2ee1dec953effb16264fa | |
| parent | 935f0de55d9aea64374ac277f839ba94b34264eb (diff) | |
| download | qmk_firmware-2443234555e3b69ba51d0a62fbf3faba09b95680.tar.gz qmk_firmware-2443234555e3b69ba51d0a62fbf3faba09b95680.zip | |
Adds a Readme for the keyboards subdirectory
| -rw-r--r-- | keyboards/readme.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/keyboards/readme.md b/keyboards/readme.md new file mode 100644 index 000000000..6f16efe49 --- /dev/null +++ b/keyboards/readme.md | |||
| @@ -0,0 +1,47 @@ | |||
| 1 | # Included Keyboards | ||
| 2 | |||
| 3 | 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. | ||
| 4 | |||
| 5 | ## Official QMK Keyboards | ||
| 6 | |||
| 7 | These keyboards are manufactured by the maintainers of QMK. | ||
| 8 | |||
| 9 | ### [Ortholinear Keyboards](http://olkb.com) — Jack Humbert | ||
| 10 | |||
| 11 | What makes OLKB keyboards shine is a combo of lean aesthetics, compact size, and killer tactile feel. These are available through [olkb.com](http://olkb.com) as well as through [Massdrop](http://massdrop.com) from time to time, as easy to assemble kits. | ||
| 12 | |||
| 13 | * [Planck](/keyboards/planck/) — A 40% DIY powerhouse of customizability and modification capability. It's a lean, mean, typing machine. | ||
| 14 | * [Preonic](/keyboards/preonic/) — Like the Planck, but bigger. 50%. | ||
| 15 | * [Atomic](/keyboards/atomic/) — Imagine the size of the Planck. Now imagine the size of the Preonic. Now imagine _bigger_. That is the Atomic. A 60% keyboard. | ||
| 16 | |||
| 17 | ### [ErgoDox EZ](https://ergodox-ez.com) — Erez Zukerman | ||
| 18 | |||
| 19 | Made in Taiwan using advanced robotic manufacturing, the ErgoDox EZ is a fully-assembled, premium ergonomic keyboard. Its split design allows you to place both halves shoulder width, and its custom-made wrist rests and tilt/tent kit make for incredibly comfortable typing. | ||
| 20 | |||
| 21 | * [ErgoDox EZ](/keyboards/ergodox_ez/) — Our one and only product. Yes, it's that awesome. Comes with either printed or blank keycaps, and 7 different keyswitch types. | ||
| 22 | |||
| 23 | ### [Clueboard](http://clueboard.co) — Zach White | ||
| 24 | |||
| 25 | Designed and built in Felton, CA, Clueboards keyboard emphasize quality and locally sourced components. | ||
| 26 | |||
| 27 | * [Clueboard rev.1](/keyboards/clueboard1/) — The old Clueboard. | ||
| 28 | * [Clueboard rev.2](/keyboards/clueboard2/) — New and improved! The Clueboard, revision 2. | ||
| 29 | * [Cluepad](/keyboards/cluepad/) — A mechanical numpad with QMK superpowers. | ||
| 30 | |||
| 31 | |||
| 32 | ## Community-supported QMK Keyboards | ||
| 33 | |||
| 34 | These keyboards are part of the QMK repository, but their manufacturers are not official maintainers of the repository. | ||
| 35 | |||
| 36 | * [alps64](/keyboards/alps64/) — A 60% keyboard for Alps keyswitches. | ||
| 37 | * [arrow_pad](/keyboards/arrow_pad) — A custom creation by IBNobody. | ||
| 38 | * [atreus](/keyboards/atreus) — Made by Technomancy. | ||
| 39 | * [bantam44](/keyboards/bantam44) — It is a 44-key 40% staggered keyboard. | ||
| 40 | * [gh60](/keyboards/gh60) — A 60% Geekhack community-driven project. | ||
| 41 | * [hhkb](/keyboards/hhkb) — The Happy Hacking keyboard can be hacked with a custom controller to run QMK. | ||
| 42 | * [jd45](/keyboards/jd45) — Another Geekhack community project, designed by jdcarpe. | ||
| 43 | * [kc60](/keyboards/kc60) — A programmable Chinese-made keyboard, lost in the mists of time. | ||
| 44 | * [phantom](/keyboards/phantom) — A tenkeyless kit by Teel, also from Geekhack. | ||
| 45 | * [retro_refit](/keyboards/retro_refit) — Another creation by IBNobody. | ||
| 46 | * [satan](/keyboards/satan) — A GH60 variant. | ||
| 47 | * [sixkeyboard](/keyboards/sixkeyboard) — A 6-key keyboard made by TechKeys. | ||
