Go to file
Jason Thigpen 31ff5f219d Move grave to top layer (caps is esc) (#4288) 2018-10-30 08:22:25 -07:00
.vscode Xton's first keymap! (#2941) 2018-05-12 08:52:11 -07:00
docs Add Bootmagic Lite to QMK (#4215) 2018-10-27 14:53:50 -04:00
drivers Remove all of the deprecated RGB defines 2018-10-22 14:55:57 -04:00
keyboards Move grave to top layer (caps is esc) (#4288) 2018-10-30 08:22:25 -07:00
layouts Minor updates to keymaps 2018-10-28 08:44:58 -07:00
lib Revert changes to chibiOS-contrib (#4176) 2018-10-19 12:42:28 -07:00
quantum Add Bootmagic Lite to QMK (#4215) 2018-10-27 14:53:50 -04:00
tests
tmk_core Fix undefined reference to `console_printf` for CTRL and ALT keyboards 2018-10-29 10:26:30 -07:00
users Add Alternate DVORAK layout 2018-10-28 08:44:58 -07:00
util Make linux_install.sh work with openSUSE Leap 15.0 (#4218) 2018-10-29 13:48:24 -07:00
.clang_complete
.editorconfig
.gitattributes
.gitignore Ajp10304 (#2719) 2018-04-15 09:48:19 -07:00
.gitmodules
.travis.yml Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2018-08-01 15:20:02 -04:00
Dockerfile
Doxyfile Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
LICENSE
Makefile improve looks like hang up when first time execute make git-submodule (#3846) 2018-09-10 16:21:54 -07:00
Vagrantfile Update the installation script PR (#4167) 2018-10-22 13:24:43 -07:00
autocomplete.sh
book.json
bootloader.mk Add Teensy ++ 2.0 bootloader support 2018-05-08 20:08:17 -04:00
build_full_test.mk
build_keyboard.mk Fix LAYOUT define generation (#4148) 2018-10-16 14:14:52 -04:00
build_layout.mk
build_test.mk
common.mk Lets split eh (#3120) 2018-07-16 22:25:02 -04:00
common_features.mk add support for encoders to core 2018-10-26 14:24:13 -07:00
doxygen-todo Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
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
shell.nix Pin avr-gcc in shell.nix pending release of 8.3.0 (#3922) 2018-09-25 15:16:35 -07:00
testlist.mk

readme.md

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.