Go to file
zvecr 4082d880bc Fix file size check for parallel make (#5012) 2019-01-30 18:20:13 -08:00
.github Add support for PR and Issue templates to QMK_firmware GitHub (#4494) 2018-12-07 16:51:27 -08:00
.vscode
docs Contribute the MechMerlin QMK Configurator docs (#4986) 2019-01-28 17:31:33 -08:00
drivers Practice60 RGB and PWM Backlight (#4929) 2019-01-28 16:40:02 -08:00
keyboards [Keyboard] 40percent.club's Half 'n' half keyboard port (#5005) 2019-01-30 18:14:27 -08:00
layouts [Keymap] Updates to ortho_4x12/buswerks keymap (#4996) 2019-01-30 08:56:25 -08:00
lib Revert changes to chibiOS-contrib (#4176) 2018-10-19 12:42:28 -07:00
quantum Backlight - New option : BACKLIGHT_CAPS_LOCK (#4769) 2019-01-28 16:57:56 -08:00
tests Remove empty action_function() 2019-01-11 18:32:43 -08:00
tmk_core Moving cannonkeys boards to one place, eeprom fix (#4999) 2019-01-29 20:04:20 -08:00
users [Keymap] Update personal userspace and keymaps (#4963) 2019-01-27 08:46:54 -08:00
util Read user input properly in linux_install.sh for Gentoo (#4395) 2018-12-26 08:01:26 -08:00
.clang_complete
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml Improve diagnostics for build hashes 2018-12-25 17:09:48 -08:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2018-08-01 15:20:02 -04:00
Dockerfile Add a better Docker build script + update Dockerfile (#4222) 2018-12-08 09:42:46 -08:00
Doxyfile
LICENSE
Makefile improve looks like hang up when first time execute make git-submodule (#3846) 2018-09-10 16:21:54 -07:00
Vagrantfile Initial fixes for vagrant (#4900) 2019-01-21 10:24:43 -08:00
autocomplete.sh
book.json
bootloader.mk
build_full_test.mk
build_keyboard.mk Fix file size check for parallel make (#5012) 2019-01-30 18:20:13 -08:00
build_layout.mk
build_test.mk
common.mk Move Split Common VPATH addition (#4716) 2018-12-31 08:45:44 -08:00
common_features.mk Simplify split_common Code significantly (#4772) 2019-01-17 10:08:14 -08:00
doxygen-todo
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 shell.nix: Packages relocated in upstream cleanup 2018-12-22 15:09:58 -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.