Go to file
QMK Bot d82e5055dd Merge remote-tracking branch 'origin/master' into develop 2021-06-16 03:36:03 +00:00
.github 2021 May 29 Breaking Changes Update (#13034) 2021-05-29 14:38:50 -07:00
.vscode vscode: specify yapf as the formatting provider (#13206) 2021-06-13 17:52:31 -07:00
api_data
bin Ensure that safe_commands always run (#13199) 2021-06-14 16:51:58 -07:00
data 2021 May 29 Breaking Changes Update (#13034) 2021-05-29 14:38:50 -07:00
docs Merge remote-tracking branch 'origin/master' into develop 2021-06-16 03:36:03 +00:00
drivers Add ST7565 LCD driver (#13089) 2021-06-10 17:16:09 +10:00
keyboards Merge remote-tracking branch 'origin/master' into develop 2021-06-16 03:34:34 +00:00
layouts Fix RGB/LED Suspend defines (#13146) 2021-06-09 22:59:19 -07:00
lib Merge remote-tracking branch 'origin/master' into develop 2021-06-14 23:52:31 +00:00
nix
platforms/chibios Set `BOOTLOADER = stm32-dfu` for all applicable STM32 boards (#12956) 2021-06-08 19:48:46 +10:00
quantum Add ST7565 LCD driver (#13089) 2021-06-10 17:16:09 +10:00
tests
tmk_core Add ST7565 LCD driver (#13089) 2021-06-10 17:16:09 +10:00
users Fix RGB/LED Suspend defines (#13146) 2021-06-09 22:59:19 -07:00
util 2021 May 29 Breaking Changes Update (#13034) 2021-05-29 14:38:50 -07:00
.clang-format
.editorconfig
.gitattributes
.gitignore 2021 May 29 Breaking Changes Update (#13034) 2021-05-29 14:38:50 -07:00
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile 2021 May 29 Breaking Changes Update (#13034) 2021-05-29 14:38:50 -07:00
Vagrantfile
book.json
bootloader.mk Slightly more prominent LUFA Mass-storage bootloader warning. (#13163) 2021-06-10 16:05:29 +10:00
build_full_test.mk
build_json.mk 2021 May 29 Breaking Changes Update (#13034) 2021-05-29 14:38:50 -07:00
build_keyboard.mk 2021 May 29 Breaking Changes Update (#13034) 2021-05-29 14:38:50 -07:00
build_layout.mk
build_test.mk Avoid 8-bit timer overflows in debounce algorithms (#12240) 2021-06-09 17:23:21 +10:00
common.mk
common_features.mk Add ST7565 LCD driver (#13089) 2021-06-10 17:16:09 +10:00
disable_features.mk
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk 2021 May 29 Breaking Changes Update (#13034) 2021-05-29 14:38:50 -07:00
nose2.cfg
readme.md
requirements-dev.txt Move hid and pyusb to requirements.txt (#13134) 2021-06-07 16:30:55 -07:00
requirements.txt Update requirements.txt (#13135) 2021-06-08 00:37:58 +01:00
secrets.tar.enc
setup.cfg
shell.nix
show_options.mk
testlist.mk Avoid 8-bit timer overflows in debounce algorithms (#12240) 2021-06-09 17:23:21 +10:00

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 powered by Docsify and hosted on GitHub. They are also viewable offline; see Previewing the Documentation for more details.

You can request changes by making a fork and opening a pull request, or by clicking the "Edit this page" link at the bottom of any page.

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 ZSA Technology Labs, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

Official Website

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