From 2443234555e3b69ba51d0a62fbf3faba09b95680 Mon Sep 17 00:00:00 2001 From: Jack & Erez Date: Wed, 22 Jun 2016 23:17:15 -0400 Subject: [PATCH] Adds a Readme for the keyboards subdirectory --- keyboards/readme.md | 47 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 keyboards/readme.md diff --git a/keyboards/readme.md b/keyboards/readme.md new file mode 100644 index 0000000000..6f16efe49a --- /dev/null +++ b/keyboards/readme.md @@ -0,0 +1,47 @@ +# 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 + +These keyboards are manufactured by the maintainers of QMK. + +### [Ortholinear Keyboards](http://olkb.com) — Jack Humbert + +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. + +* [Planck](/keyboards/planck/) — A 40% DIY powerhouse of customizability and modification capability. It's a lean, mean, typing machine. +* [Preonic](/keyboards/preonic/) — Like the Planck, but bigger. 50%. +* [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. + +### [ErgoDox EZ](https://ergodox-ez.com) — Erez Zukerman + +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. + +* [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. + +### [Clueboard](http://clueboard.co) — Zach White + +Designed and built in Felton, CA, Clueboards keyboard emphasize quality and locally sourced components. + +* [Clueboard rev.1](/keyboards/clueboard1/) — The old Clueboard. +* [Clueboard rev.2](/keyboards/clueboard2/) — New and improved! The Clueboard, revision 2. +* [Cluepad](/keyboards/cluepad/) — A mechanical numpad with QMK superpowers. + + +## Community-supported QMK Keyboards + +These keyboards are part of the QMK repository, but their manufacturers are not official maintainers of the repository. + +* [alps64](/keyboards/alps64/) — A 60% keyboard for Alps keyswitches. +* [arrow_pad](/keyboards/arrow_pad) — A custom creation by IBNobody. +* [atreus](/keyboards/atreus) — Made by Technomancy. +* [bantam44](/keyboards/bantam44) — It is a 44-key 40% staggered keyboard. +* [gh60](/keyboards/gh60) — A 60% Geekhack community-driven project. +* [hhkb](/keyboards/hhkb) — The Happy Hacking keyboard can be hacked with a custom controller to run QMK. +* [jd45](/keyboards/jd45) — Another Geekhack community project, designed by jdcarpe. +* [kc60](/keyboards/kc60) — A programmable Chinese-made keyboard, lost in the mists of time. +* [phantom](/keyboards/phantom) — A tenkeyless kit by Teel, also from Geekhack. +* [retro_refit](/keyboards/retro_refit) — Another creation by IBNobody. +* [satan](/keyboards/satan) — A GH60 variant. +* [sixkeyboard](/keyboards/sixkeyboard) — A 6-key keyboard made by TechKeys.