Go to file
Jack Humbert ca01d94005 convert docs to lowercase and underscores 2017-06-10 14:58:24 -04:00
docs convert docs to lowercase and underscores 2017-06-10 14:58:24 -04:00
keyboards convert docs to lowercase and underscores 2017-06-10 14:58:24 -04:00
lib Add Google Test submodule 2016-08-27 21:57:49 +03:00
quantum Prevent the recording of looping dynamic macros. 2017-06-01 16:29:58 +01:00
tmk_core Adding permissive_hold 2017-06-03 10:28:46 -04:00
util make qmk bot do the hard work 2017-05-30 12:49:26 -04:00
.gitattributes Set eep files to binary mode 2016-08-27 18:37:28 +03:00
.gitignore Download windows flashing utils and driver_installer 2017-05-28 21:30:55 +03:00
.gitmodules Add Google Test submodule 2016-08-27 21:57:49 +03:00
.travis.yml exclude PRs 2017-05-30 11:46:25 -04:00
Dockerfile adding lets split keymap 2017-06-03 10:28:46 -04:00
Makefile Add SKIP_VERSION option to speed up compilation 2017-04-13 16:00:29 +03:00
Vagrantfile Update some obsolete references 2016-07-30 08:37:30 +02:00
book.json convert docs to lowercase and underscores 2017-06-10 14:58:24 -04:00
build_keyboard.mk Fix process_unicode_common.c being included twice 2017-04-13 16:03:01 +03:00
build_test.mk Disable map file creation when building tests 2016-08-27 21:57:49 +03:00
common.mk separated into api files/folder 2016-11-26 15:38:44 -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
message.mk Detect failures when running multiple tests 2016-08-27 21:57:49 +03:00
readme.md update docs link 2017-06-05 16:25:59 -04:00
secrets.tar.enc get rid of folders in tar 2017-05-29 11:37:20 -04:00
testlist.mk Basic framework for parsing test targets 2016-08-27 21:57:49 +03:00

readme.md

Quantum Mechanical Keyboard Firmware

Build Status Gitter 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.

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.

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, and the Clueboard by Zach White.

Documentation

https://docs.qmk.fm is 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.