qmk-firmware/keyboards/readme.md

46 lines
2.9 KiB
Markdown
Raw Normal View History

# 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)
Implements subprojects and updates projects for this (#459) * non-working commit * working * subprojects implemented for planck * pass a subproject variable through to c * consolidates clueboard revisions * thanks for letting me know about conflicts.. * turn off audio for yang's * corrects starting paths for subprojects * messing around with travis * semicolon * travis script * travis script * script for travis * correct directory (probably), amend files to commit * remove origin before adding * git pull, correct syntax * git checkout * git pull origin branch * where are we? * where are we? * merging * force things to happen * adds commit message, adds add * rebase, no commit message * rebase branch * idk! * try just pull * fetch - merge * specify repo branch * checkout * goddammit * merge? idk * pls * after all * don't split up keyboards * syntax * adds quick for all-keyboards * trying out new script * script update * lowercase * all keyboards * stop replacing compiled.hex automatically * adds if statement * skip automated build branches * forces push to automated build branch * throw an add in there * upstream? * adds AUTOGEN * ignore all .hex files again * testing out new repo * global ident * generate script, keyboard_keymap.hex * skip generation for now, print pandoc info, submodule update * try trusty * and sudo * try generate * updates subprojects to keyboards * no idea * updates to keyboards * cleans up clueboard stuff * setup to use local readme * updates cluepad, planck experimental * remove extra led.c [ci skip] * disable power up for now * config files updates * makefile updates * .h file updates, config tuning * disable audio for yang
2016-06-29 20:21:41 +00:00
* [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.