Go to file
Drashna Jaelre c9a2d9d1aa Additional cleanup of orthodox files and keymaps 2019-04-05 14:58:42 -07: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 Custom Tapping Term per key (#5009) 2019-04-05 15:47:25 -04:00
drivers Fix return value of i2c_readReg and i2c_receive (#5410) 2019-03-15 08:55:07 -07:00
keyboards Additional cleanup of orthodox files and keymaps 2019-04-05 14:58:42 -07:00
layouts RGB Matrix Overhaul (#5372) 2019-04-02 17:24:14 -07:00
lib RGB Matrix Overhaul (#5372) 2019-04-02 17:24:14 -07:00
quantum Custom Tapping Term per key (#5009) 2019-04-05 15:47:25 -04:00
tests Remove empty action_function() 2019-01-11 18:32:43 -08:00
tmk_core Custom Tapping Term per key (#5009) 2019-04-05 15:47:25 -04:00
users remove call to custom rgb file 2019-04-03 09:19:22 -04:00
util Update build instructions and Dockerfile to download submodules 2019-03-30 10:48:09 -07:00
.clang-format Add .clang-format file 2019-02-17 08:59:19 -08:00
.clang_complete
.editorconfig Fix .editorconfig to not mess with line endings 2018-02-03 15:20:44 -05:00
.gitattributes
.gitignore Add Satisfaction75 to QMK, Enable EEPROM on stm32f072 (#5094) 2019-02-13 08:03:26 -08:00
.gitmodules
.travis.yml Remove AUTOGEN and fix Travis Compiled Push scripts (#5077) 2019-02-12 16:46:04 -08:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2018-08-01 15:20:02 -04:00
Dockerfile Update build instructions and Dockerfile to download submodules 2019-03-30 10:48:09 -07:00
Doxyfile Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
LICENSE
Makefile Shallow clone submodules. (#5279) 2019-03-08 07:58:40 -08:00
Vagrantfile Align docker and vagrant base images (#4905) 2019-03-17 10:36:59 -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 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
common.mk Move Split Common VPATH addition (#4716) 2018-12-31 08:45:44 -08:00
common_features.mk Next set of split_common changes (#4974) 2019-03-12 10:23:28 -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 build size-check enhancement (#5485) 2019-03-27 08:51:56 -07:00
readme.md Add Atreus as an official board. 2018-08-16 12:01:34 -04:00
secrets.tar.enc
shell.nix shell.nix: Packages relocated in upstream cleanup 2018-12-22 15:09:58 -08:00
show_options.mk Clean up debounce a bit (#5255) 2019-03-04 07:44:46 -08: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.