aboutsummaryrefslogtreecommitdiffstats
path: root/README
Commit message (Expand)AuthorAgeFilesLines
* build: README punctuation pendantryKevin Darbyshire-Bryant2018-07-081-2/+2
* build: Update README & github helpKevin Darbyshire-Bryant2018-07-081-16/+21
* merge: base: update base-files and basic configZoltan HERPAI2017-12-081-3/+3
* README: Update project READMEKevin Darbyshire-Bryant2016-05-121-1/+1
* README: Remove outdated infoJo-Philipp Wich2016-05-111-6/+0
* branding: add LEDE brandingJohn Crispin2016-03-241-4/+4
* Add 'subversion' build dependency to READMEFelix Fietkau2014-08-311-2/+2
* build: BSD compile fixesFelix Fietkau2013-03-071-2/+2
* Update README fileMirko Vogt2013-03-061-2/+3
* trying to make README file a bit more helpfulMirko Vogt2012-01-211-6/+14
* remove bison requirement (see [10398] & [14900])Nicolas Thill2010-03-051-1/+1
* change readme to point to scripts/flashing/flash.sh instead of scripts/flash.shFelix Fietkau2008-12-311-2/+2
* add information about the tex4ht requirement for the docsFelix Fietkau2007-02-261-1/+1
* Update the README to something more realisticFlorian Fainelli2007-01-051-2/+4
* finally move buildroot-ng to trunkFelix Fietkau2016-03-201-0/+24
dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
# 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 - 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 - 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. Available on [ergodox-ez.com](https://ergodox-ez.com).

* [ErgoDox EZ](/keyboards/ergodox/) - Our one and only product. Yes, it's that awesome. Comes with either printed or blank keycaps, and 7 different keyswitch types.

### Clueboard - Zach White

Designed and built in Felton, CA, Clueboards keyboard emphasize quality and locally sourced components, available on [clueboard.co](http://clueboard.co)

* [Clueboard](/keyboards/clueboard/) - The 66% custom keyboard.
* [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.