You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Jack Humbert d2123f3c07 remove some outdated changes 3 years ago
.github [CI] Auto Formatting - Swap from direct commit to PR (#11229) 3 years ago
.vscode [Keyboard] add rhymestone by marksard (#9708) 3 years ago
api_data Generate api data on each push (#10609) 3 years ago
bin Move everything to Python 3.6 (#8835) 4 years ago
docs Rework I2C driver docs (#11658) 3 years ago
drivers Add BGR byte order for WS2812 drivers (#11562) 3 years ago
keyboards remove some outdated changes 3 years ago
layouts [Keymap] Update community ortholinear 4x12 keymap: junonum (#11757) 3 years ago
lib Allow flash/compile to accept relative json paths (#11767) 3 years ago
platforms/chibios Ensure single newline at EOF for core files (#11310) 3 years ago
quantum remove some outdated changes 3 years ago
tests Missed a couple more `#pragma once`s (#11351) 3 years ago
tmk_core merge from master 3 years ago
users [Keyboard] Add my keymap for Mark65 (#11717) 3 years ago
util Exclude more keyboards from CI (#11436) 3 years ago
.clang-format fix indent size 4 years ago
.editorconfig QMK CLI and JSON keymap support (#6176) 4 years ago
.gitattributes Set eep files to binary mode 7 years ago
.gitignore Generate api data on each push (#10609) 3 years ago
.gitmodules 2020 May 30 Breaking Changes Update (#9215) 3 years ago
.travis.yml CI: Add workflow for codebase formatting (#7382) 3 years ago
CODE_OF_CONDUCT.md updates the coc 4 years ago
Dockerfile Update docker util script and travis to use new base container 4 years ago
Doxyfile Generate API docs from source code comments (#2491) 6 years ago
LICENSE add an explicit lisence file for github to pickup 6 years ago
Makefile remove some old and unused code from Makefile (#11336) 3 years ago
Vagrantfile Remove broken example from Makefile (#9159) 3 years ago
book.json adds redirects for docs 6 years ago
bootloader.mk Add stm32-dfu and apm32-dfu to bootloader.mk (#11019) 3 years ago
build_full_test.mk Ensure single newline at EOF for core files (#11310) 3 years ago
build_json.mk Load keymap-level rules.mk when compiling keymap.json (#8841) 4 years ago
build_keyboard.mk Add a <FEATURE>_SUPPORTED flag (#9058) 3 years ago
build_layout.mk Allow for building layouts from keymap.json files. 3 years ago
build_test.mk Ensure single newline at EOF for core files (#11310) 3 years ago
common.mk 2020 November 28 Breaking Changes Update (#11053) 3 years ago
common_features.mk merge from master 3 years ago
disable_features.mk Add a <FEATURE>_SUPPORTED flag (#9058) 3 years ago
doxygen-todo Remove iWRAP protocol (#9284) 3 years ago
license_GPLv2.md Clarify the quantum license (#1042) 7 years ago
license_GPLv3.md Clarify the quantum license (#1042) 7 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 7 years ago
message.mk 2020 November 28 Breaking Changes Update (#11053) 3 years ago
nose2.cfg Setup a python test framework 4 years ago
readme.md Breaking Changes documentation fixes 4 years ago
requirements-dev.txt Use milc for config check, requirements fixes 4 years ago
requirements.txt 2020 November 28 Breaking Changes Update (#11053) 3 years ago
secrets.tar.enc update building for .hex, secrets moving 6 years ago
setup.cfg Ensure single newline at EOF for core files (#11310) 3 years ago
shell.nix allow customizing decrease delay of rgb heatmap (#11322) 3 years ago
show_options.mk 2020 November 28 Breaking Changes Update (#11053) 3 years ago
testlist.mk Ensure single newline at EOF for core files (#11310) 3 years ago

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.