[jackhill/qmk/firmware.git] / keyboards / readme.md

# 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

### 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/) &mdash; A 40% DIY powerhouse of customizability and modification capability. It's a lean, mean, typing machine.
* [Preonic](/keyboards/preonic/) &mdash; Like the Planck, but bigger. 50%.
* [Atomic](/keyboards/atomic/) &mdash; Imagine the size of the Planck. Now imagine the size of the Preonic. Now imagine _bigger_. That is the Atomic. A 60% keyboard.

### 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/66/) &mdash; The 66% custom keyboard.
* [Cluecard](/keyboards/clueboard/card/) &mdash; A small board to help you hack on QMK.
* [Cluepad](/keyboards/clueboard/17/) &mdash; A mechanical numpad with QMK superpowers.

### ErgoDox EZ and Planck EZ - ZSA Technology Labs

[ZSA Technology Labs](https://ergodox-ez.com) maintains its own [fork of QMK](https://github.com/zsa/qmk_firmware) which feeds its [configurator](https://configure.ergodox-ez.com), for stability and legal purposes. The ZSA boards are:

* [ErgoDox EZ](/keyboards/ergodox_ez/) &mdash; A powerful split mechanical keyboard.
* [Planck EZ](/keyboards/planck/ez) &mdash; A 40% DIY powerhouse of customizability and modification capability. It's a lean, mean, typing machine, which ships fully assembled with a two-year warranty.


## Community-supported QMK Keyboards

These keyboards are part of the QMK repository, but their manufacturers are not official maintainers of the repository.

* [9key](/keyboards/9key) &mdash; A 9-key minipad sold by Bishop Keyboards.
* [Alps64](/keyboards/alps64) &mdash; A 60% keyboard for Alps keyswitches.
* [AMJ60](/keyboards/amj60) &mdash; DIY/Assembled compact 60% keyboard.
* [Arrow Pad](/keyboards/handwired/arrow_pad) &mdash; A custom creation by IBNobody.
* [Atreus](/keyboards/atreus) &mdash; Made by Technomancy.
* [Bantam44](/keyboards/bantam44) &mdash; It is a 44-key 40% staggered keyboard.
* [DataHand](/keyboards/handwired/datahand) &mdash; DataHand keyboard converted to use a Teensy board.
* [Ergodox Infinity](/keyboards/ergodox_infinity) - Ergonomic Split Keyboard by Input Club.
* [GH60](/keyboards/gh60) &mdash; A 60% Geekhack community-driven project.
* [GON NerD](/keyboards/gonnerd) &mdash; Korean custom 60% PCB
* [Happy Hacking Keyboard](/keyboards/hhkb) &mdash; The Happy Hacking keyboard can be hacked with a custom controller to run QMK.
* [Infinity 60%](/keyboards/infinity60) - &mdash; Compact community keyboard by Input Club.
* [JD45](/keyboards/jd45) &mdash; Another Geekhack community project, designed by jdcarpe.
* [JJ40](/keyboards/jj40) &mdash; ps2avrGB based ortholinear sold by KPrepublic
* [KBD75](/keyboards/kbd75) &mdash; A 75% keyboard made by made by KBDFans.
* [KC60](/keyboards/kc60) &mdash; A programmable Chinese-made keyboard, lost in the mists of time.
* [Kinesis Advantage](/keyboards/kinesis) &mdash; Contoured ergonomic keyboard by Kinesis Computer Ergonomics.
* [KMAC](/keyboards/kmac) &mdash; Korean custom keyboard.
* [The Kitten Paw](/keyboards/kitten_paw) &mdash; A replacement controller (2016 revision) for the Filco Majestouch by [Bathroom Epiphanies](https://github.com/BathroomEpiphanies).
* [Lets Split](/keyboards/lets_split) - Split ortholinear 40% keyboard.
* [Phantom](/keyboards/phantom) &mdash; A tenkeyless kit by Teel, also from Geekhack.
* [Retro Refit](/keyboards/handwired/retro_refit) &mdash; Another creation by IBNobody.
* [S60-x](/keyboards/s60_x) &mdash; DIY compact keyboard designed by VinnyCordeiro for Sentraq.
* [Satan](/keyboards/satan) &mdash; A GH60 variant.
* [SixKeyBoard](/keyboards/sixkeyboard) &mdash; A 6-key keyboard made by TechKeys.
* [TheVan 44](/keyboards/tv44) &mdash; A 44-key staggered keybard by Evangs.
* [WhiteFox](/keyboards/whitefox) &mdash; A 65% keyboard designed as a partnership by matt3o, Massdrop and Input Club
* [Vision Division](/keyboards/vision_division) &mdash; Full Size / Split Linear Keyboard by IBNobody.
* [XD004](/keyboards/xd004) &mdash; 1x4 macro keyboard sold by KPrepublic.
* [XD75](/keyboards/xd75) &mdash; 15x5 ortholinear keyboard by XIUDI.
* [YMDK NP21](/keyboards/ymdk_np21) &mdash; ps2avrGB based number pad (numpad) sold by YMDK on Aliexpress.
Commit	Line	Data
24432345	1	# Included Keyboards
24432345 JE	2	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.
	3
	4	## Official QMK Keyboards
	5
13bb6b4b	6	### Ortholinear Keyboards - Jack Humbert
24432345 JE	7
	8	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.
	9
3bdebd22 FS	10	* [Planck](/keyboards/planck/) — A 40% DIY powerhouse of customizability and modification capability. It's a lean, mean, typing machine.
	11	* [Preonic](/keyboards/preonic/) — Like the Planck, but bigger. 50%.
	12	* [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.
24432345	13
13bb6b4b	14	### Clueboard - Zach White
24432345	15
13bb6b4b	16	Designed and built in Felton, CA, Clueboards keyboard emphasize quality and locally sourced components, available on [clueboard.co](http://clueboard.co)
24432345	17
1485cc1d	18	* [Clueboard](/keyboards/clueboard/66/) — The 66% custom keyboard.
	19	* [Cluecard](/keyboards/clueboard/card/) — A small board to help you hack on QMK.
	20	* [Cluepad](/keyboards/clueboard/17/) — A mechanical numpad with QMK superpowers.
24432345	21
8680c50d EZ	22	### ErgoDox EZ and Planck EZ - ZSA Technology Labs
	23
	24	[ZSA Technology Labs](https://ergodox-ez.com) maintains its own [fork of QMK](https://github.com/zsa/qmk_firmware) which feeds its [configurator](https://configure.ergodox-ez.com), for stability and legal purposes. The ZSA boards are:
	25
	26	* [ErgoDox EZ](/keyboards/ergodox_ez/) — A powerful split mechanical keyboard.
	27	* [Planck EZ](/keyboards/planck/ez) — A 40% DIY powerhouse of customizability and modification capability. It's a lean, mean, typing machine, which ships fully assembled with a two-year warranty.
	28
24432345 JE	29
	30	## Community-supported QMK Keyboards
	31
	32	These keyboards are part of the QMK repository, but their manufacturers are not official maintainers of the repository.
	33
b2d033ff	34	* [9key](/keyboards/9key) — A 9-key minipad sold by Bishop Keyboards.
3bdebd22 FS	35	* [Alps64](/keyboards/alps64) — A 60% keyboard for Alps keyswitches.
3bdebd22 FS	36	* [AMJ60](/keyboards/amj60) — DIY/Assembled compact 60% keyboard.
3f4d706c	37	* [Arrow Pad](/keyboards/handwired/arrow_pad) — A custom creation by IBNobody.
3bdebd22 FS	38	* [Atreus](/keyboards/atreus) — Made by Technomancy.
3bdebd22 FS	39	* [Bantam44](/keyboards/bantam44) — It is a 44-key 40% staggered keyboard.
6b1009b7	40	* [DataHand](/keyboards/handwired/datahand) — DataHand keyboard converted to use a Teensy board.
9a23fad3	41	* [Ergodox Infinity](/keyboards/ergodox_infinity) - Ergonomic Split Keyboard by Input Club.
3bdebd22	42	* [GH60](/keyboards/gh60) — A 60% Geekhack community-driven project.
5daa3a88	43	* [GON NerD](/keyboards/gonnerd) — Korean custom 60% PCB
3bdebd22 FS	44	* [Happy Hacking Keyboard](/keyboards/hhkb) — The Happy Hacking keyboard can be hacked with a custom controller to run QMK.
	45	* [Infinity 60%](/keyboards/infinity60) - — Compact community keyboard by Input Club.
	46	* [JD45](/keyboards/jd45) — Another Geekhack community project, designed by jdcarpe.
056ecb14	47	* [JJ40](/keyboards/jj40) — ps2avrGB based ortholinear sold by KPrepublic
e71b3c65	48	* [KBD75](/keyboards/kbd75) — A 75% keyboard made by made by KBDFans.
3bdebd22 FS	49	* [KC60](/keyboards/kc60) — A programmable Chinese-made keyboard, lost in the mists of time.
3bdebd22 FS	50	* [Kinesis Advantage](/keyboards/kinesis) — Contoured ergonomic keyboard by Kinesis Computer Ergonomics.
1b02b200	51	* [KMAC](/keyboards/kmac) — Korean custom keyboard.
3bdebd22 FS	52	* [The Kitten Paw](/keyboards/kitten_paw) — A replacement controller (2016 revision) for the Filco Majestouch by [Bathroom Epiphanies](https://github.com/BathroomEpiphanies).
	53	* [Lets Split](/keyboards/lets_split) - Split ortholinear 40% keyboard.
	54	* [Phantom](/keyboards/phantom) — A tenkeyless kit by Teel, also from Geekhack.
3f4d706c	55	* [Retro Refit](/keyboards/handwired/retro_refit) — Another creation by IBNobody.
7f7f7635	56	* [S60-x](/keyboards/s60_x) — DIY compact keyboard designed by VinnyCordeiro for Sentraq.
3bdebd22 FS	57	* [Satan](/keyboards/satan) — A GH60 variant.
3bdebd22 FS	58	* [SixKeyBoard](/keyboards/sixkeyboard) — A 6-key keyboard made by TechKeys.
ca9a3dcb	59	* [TheVan 44](/keyboards/tv44) — A 44-key staggered keybard by Evangs.
ccde1d8b	60	* [WhiteFox](/keyboards/whitefox) — A 65% keyboard designed as a partnership by matt3o, Massdrop and Input Club
3bdebd22	61	* [Vision Division](/keyboards/vision_division) — Full Size / Split Linear Keyboard by IBNobody.
a200f194	62	* [XD004](/keyboards/xd004) — 1x4 macro keyboard sold by KPrepublic.
d272111d	63	* [XD75](/keyboards/xd75) — 15x5 ortholinear keyboard by XIUDI.
2480e5d6	64	* [YMDK NP21](/keyboards/ymdk_np21) — ps2avrGB based number pad (numpad) sold by YMDK on Aliexpress.