Go to file
QMK Bot 95c742ec27 format code according to conventions [skip ci] 2020-07-25 22:33:55 +00:00
.github
.vscode
bin
docs [Docs] Update Japanese translation of custom_quantum_functions.md. (#9760) 2020-07-25 09:36:48 +09:00
drivers Enable OLED support for Teensy 3.2/LC (#7591) 2020-07-26 07:50:56 +10:00
keyboards Enable OLED support for Teensy 3.2/LC (#7591) 2020-07-26 07:50:56 +10:00
layouts Switch bcat Chrome OS media keys workaround from mouse keys to NKRO (#9790) 2020-07-23 15:27:01 +01:00
lib Remove `DESCRIPTION` (#9732) 2020-07-16 15:49:18 +10:00
quantum Redefine IS_LAYER_ON/OFF() as aliases for existing layer functions (#6352) 2020-07-16 22:27:55 +10:00
tests
tmk_core format code according to conventions [skip ci] 2020-07-25 22:33:55 +00:00
users Keymap for OSAv2 (#9773) 2020-07-25 03:10:00 -07:00
util MSYS2: Switch to bootloadHID package and bring back avrdude package (#9736) 2020-07-16 18:01:34 +01:00
.clang-format
.editorconfig
.gitattributes
.gitignore Allow for user song list (#9281) 2020-07-16 16:45:50 +10:00
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile
Vagrantfile
book.json
bootloader.mk
build_full_test.mk
build_json.mk
build_keyboard.mk
build_layout.mk
build_test.mk
common.mk
common_features.mk
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk
nose2.cfg
readme.md
requirements-dev.txt
requirements.txt
secrets.tar.enc
setup.cfg
shell.nix shell.nix improvements, and fix problems on Darwin (#9551) 2020-07-08 21:50:01 +01:00
show_options.mk
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 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.