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.
 
 
 
 
 
Zach White 4cfe36d6d0 Generate an initial changelog and a script to generate it 1 year ago
.github Yet another stab at trying to get github actions to push (#11230) 1 year ago
.vscode [Keyboard] add rhymestone by marksard (#9708) 2 years ago
api_data Generate api data on each push (#10609) 2 years ago
bin Move everything to Python 3.6 (#8835) 2 years ago
data/schemas Adds AT90USB162 support (#11570) 1 year ago
docs Generate an initial changelog and a script to generate it 1 year ago
drivers Include stdbool.h in uart.h (#11728) 1 year ago
keyboards Merge remote-tracking branch 'origin/master' into develop 1 year ago
layouts check for BACKLIGHT_ENABLE so this works on all keyboards 1 year ago
lib Generate an initial changelog and a script to generate it 1 year ago
platforms/chibios UART driver refactor (#11637) 1 year ago
quantum Enforce memory allocator for ChibiOS builds with allocating debounce algorithms (#11630) 1 year ago
tests Missed a couple more `#pragma once`s (#11351) 1 year ago
tmk_core Merge remote-tracking branch 'upstream/master' into develop 1 year ago
users undef TAPPING_TERM in users/hvp/hvp.h 1 year ago
util Adds AT90USB162 support (#11570) 1 year ago
.clang-format fix indent size 3 years ago
.editorconfig QMK CLI and JSON keymap support (#6176) 3 years ago
.gitattributes Set eep files to binary mode 6 years ago
.gitignore Generate api data on each push (#10609) 2 years ago
.gitmodules 2020 May 30 Breaking Changes Update (#9215) 2 years ago
.travis.yml CI: Add workflow for codebase formatting (#7382) 2 years ago
CODE_OF_CONDUCT.md updates the coc 3 years ago
Dockerfile Update docker util script and travis to use new base container 3 years ago
Doxyfile Generate API docs from source code comments (#2491) 4 years ago
LICENSE add an explicit lisence file for github to pickup 5 years ago
Makefile Configure keyboard matrix from info.json (#10817) 1 year ago
Vagrantfile Remove broken example from Makefile (#9159) 2 years ago
book.json adds redirects for docs 5 years ago
bootloader.mk Adds AT90USB162 support (#11570) 1 year ago
build_full_test.mk Ensure single newline at EOF for core files (#11310) 1 year ago
build_json.mk Load keymap-level rules.mk when compiling keymap.json (#8841) 2 years ago
build_keyboard.mk Merge remote-tracking branch 'origin/master' into develop 1 year ago
build_layout.mk Allow for building layouts from keymap.json files. 2 years ago
build_test.mk Ensure single newline at EOF for core files (#11310) 1 year ago
common.mk 2020 November 28 Breaking Changes Update (#11053) 2 years ago
common_features.mk Adds AT90USB162 support (#11570) 1 year ago
disable_features.mk Add a <FEATURE>_SUPPORTED flag (#9058) 1 year ago
doxygen-todo Remove iWRAP protocol (#9284) 2 years ago
license_GPLv2.md Clarify the quantum license (#1042) 5 years ago
license_GPLv3.md Clarify the quantum license (#1042) 5 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 5 years ago
message.mk Configure keyboard matrix from info.json (#10817) 1 year ago
nose2.cfg Setup a python test framework 3 years ago
readme.md Branch point for 2021 Feb 27 Breaking Change 2 years ago
requirements-dev.txt Use milc for config check, requirements fixes 2 years ago
requirements.txt validate keyboard data with jsonschema 1 year ago
secrets.tar.enc update building for .hex, secrets moving 5 years ago
setup.cfg Use the schema to eliminate custom code (#11108) 1 year ago
shell.nix allow customizing decrease delay of rgb heatmap (#11322) 1 year ago
show_options.mk 2020 November 28 Breaking Changes Update (#11053) 2 years ago
testlist.mk Ensure single newline at EOF for core files (#11310) 1 year ago

readme.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

THIS IS THE DEVELOP BRANCH

Warning- This is the develop branch of QMK Firmware. You may encounter broken code here. Please see Breaking Changes for more information.

Original readme continues

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.