No description
Find a file
Johannes Jansson 9f1d781fcb Updated hand wiring docs (#5198)
* renamed KEYMAP to LAYOUT in hand wiring docs

* added two additional guides for hand wiring
2019-02-20 17:27:27 -08:00
.github Tweak issue templates (capitalisation mostly) (#5133) 2019-02-14 20:44:27 -08:00
.vscode Xton's first keymap! (#2941) 2018-05-12 08:52:11 -07:00
docs Updated hand wiring docs (#5198) 2019-02-20 17:27:27 -08:00
drivers Haptic feedback generalized - DRV2605 and solenoids (#4939) 2019-02-16 18:39:30 -08:00
keyboards Reduce tetris firmware size by disabling default audio (#5197) 2019-02-20 14:46:30 -08:00
layouts Migrate ACTION_LAYER_TAP_TOGGLEs to TT() 2019-02-18 08:52:51 -08:00
lib Revert changes to chibiOS-contrib (#4176) 2018-10-19 12:42:28 -07:00
quantum Fix quantum/split_common/matrix.c: select_col()/select_row() (#5174) 2019-02-18 13:55:20 -08:00
tests Remove empty action_function() 2019-01-11 18:32:43 -08:00
tmk_core Fixed grep issue in bootloader build target (#3848) 2019-02-18 10:00:33 -08:00
users Change Command keycode defaults to match corresponding Bootmagic codes (#5078) 2019-02-17 22:23:32 -08:00
util Relocate usb_detach to utils (#5121) 2019-02-18 09:03:44 -08:00
.clang-format Add .clang-format file 2019-02-17 08:59:19 -08:00
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) 2017-12-11 21:06:05 -05:00
.editorconfig Fix .editorconfig to not mess with line endings 2018-02-03 15:20:44 -05:00
.gitattributes Set eep files to binary mode 2016-08-27 18:37:28 +03:00
.gitignore Add Satisfaction75 to QMK, Enable EEPROM on stm32f072 (#5094) 2019-02-13 08:03:26 -08:00
.gitmodules Update .gitmodules 2017-11-16 15:09:45 -05:00
.travis.yml Remove AUTOGEN and fix Travis Compiled Push scripts (#5077) 2019-02-12 16:46:04 -08:00
autocomplete.sh Make arguments redo, subproject elimination (#1784) 2017-10-14 11:32:19 -10:00
book.json adds redirects for docs 2017-08-19 08:31:54 -04:00
bootloader.mk Add Teensy ++ 2.0 bootloader support 2018-05-08 20:08:17 -04:00
build_full_test.mk Add SRC and OPT_DEFS when building tests 2017-07-20 10:17:31 -04:00
build_keyboard.mk Add a mechanism for force building a particular community layout (#5027) 2019-02-14 20:14:26 -08:00
build_layout.mk Add a mechanism for force building a particular community layout (#5027) 2019-02-14 20:14:26 -08:00
build_test.mk Split common.mk into common.mk and common_features.mk 2017-06-18 21:22:22 +03:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2018-08-01 15:20:02 -04:00
common.mk Move Split Common VPATH addition (#4716) 2018-12-31 08:45:44 -08:00
common_features.mk Haptic feedback generalized - DRV2605 and solenoids (#4939) 2019-02-16 18:39:30 -08:00
Dockerfile Add a better Docker build script + update Dockerfile (#4222) 2018-12-08 09:42:46 -08:00
Doxyfile Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
doxygen-todo Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
LICENSE add an explicit lisence file for github to pickup 2017-11-13 20:50:54 -05:00
license_GPLv2.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_GPLv3.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_Modified_BSD.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
Makefile Add distclean target instead 2019-02-05 09:49:24 -08:00
message.mk Treat too-large firmwares as an error, not a warning (#3956) 2018-09-27 13:32:01 -07:00
readme.md Add Atreus as an official board. 2018-08-16 12:01:34 -04:00
secrets.tar.enc update building for .hex, secrets moving 2017-08-21 21:57:46 -04:00
shell.nix shell.nix: Packages relocated in upstream cleanup 2018-12-22 15:09:58 -08:00
show_options.mk Add makefile target 'show_build_options' and 'show_all_features' (#5048) 2019-02-14 17:52:58 -08:00
testlist.mk Add basic infrastrucure for building full tests 2017-06-18 21:08:23 +03:00
Vagrantfile Initial fixes for vagrant (#4900) 2019-01-21 10:24:43 -08:00

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

This is a keyboard firmware based on the tmk_keyboard firmware with some useful features for Atmel AVR and ARM controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line.

Documentation

The docs are hosted on Gitbook and GitHub (they are synced). You can request changes by making a fork and pull request, or by clicking the "suggest an edit" link on any page of the docs.

Supported Keyboards

The project also includes community support for lots of other keyboards.

Maintainers

QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, Hasu. The OLKB product firmwares are maintained by Jack Humbert, the Ergodox EZ by Erez Zukerman, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

Official website

http://qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.