You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
QMK Bot ad4f954b66 Merge remote-tracking branch 'origin/master' into develop 4 years ago
.github
.vscode
api_data
builddefs Standardise error output. (#16220) 4 years ago
data Add `custom` to list of valid bootloader types in info.json (#16228) 4 years ago
docs Remove default pointing device driver. (#16190) 4 years ago
drivers Update outputselect to use platform connected state API (#16185) 4 years ago
keyboards Merge remote-tracking branch 'origin/master' into develop 4 years ago
layouts [Keymap] Remove Ergodox community layout “coderkun_neo2” (#16011) 4 years ago
lib Skip categorisation of PR if it's only for code formatting. (#16215) 4 years ago
platforms Followup to #16220, more test error output. (#16221) 4 years ago
quantum RGB Matrix: Reload from EEPROM (#15923) 4 years ago
tests Rip out old macro and action_function system (#16025) 4 years ago
tmk_core ChibiOS: add support for HID Programmable Buttons (#15787) 4 years ago
users [Keyboard] Overhaul Tractyl Manuform (#16134) 4 years ago
util Add a script that simplifies running commands under docker. (#16028) 4 years ago
.clang-format
.editorconfig
.gitattributes eol=lf, where appropriate (#15752) 4 years ago
.gitignore add version.h to gitignore (#16222) 4 years ago
.gitmodules
Dockerfile
Doxyfile
LICENSE
Makefile Workaround in Makefile for recursive rule matching (#15988) 4 years ago
Vagrantfile
build_full_test.mk
build_json.mk
build_keyboard.mk Standardise error output. (#16220) 4 years ago
build_layout.mk Standardise error output. (#16220) 4 years ago
build_test.mk
common_features.mk Remove default pointing device driver. (#16190) 4 years ago
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
nose2.cfg
paths.mk
readme.md
requirements-dev.txt
requirements.txt
setup.cfg
shell.nix
testlist.mk Followup to #16220, more test error output. (#16221) 4 years ago

readme.md

This is the develop branch!

See the Breaking Changes document for more information.

Quantum Mechanical Keyboard Firmware

Current Version 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.