Go to file
QMK Bot 344f61f247 Merge remote-tracking branch 'origin/master' into develop 2021-01-21 15:35:05 +00:00
.github Yet another stab at trying to get github actions to push (#11230) 2020-12-16 23:00:02 +00:00
.vscode
api_data Generate api data on each push (#10609) 2020-10-25 14:48:44 -07:00
bin
data/schemas Add support for specifying BOARD in info.json (#11492) 2021-01-09 20:18:47 -08:00
docs Merge remote-tracking branch 'origin/master' into develop 2021-01-20 18:46:42 +00:00
drivers Merge remote-tracking branch 'origin/master' into develop 2021-01-15 21:43:07 +00:00
keyboards Merge remote-tracking branch 'origin/master' into develop 2021-01-21 15:35:05 +00:00
layouts Merge remote-tracking branch 'origin/master' into develop 2021-01-20 01:42:07 +00:00
lib ChibiOS conf migrations... take 11 (#11646) 2021-01-21 17:00:53 +11:00
platforms/chibios ChibiOS enable memory allocations (#11620) 2021-01-19 14:50:51 +00:00
quantum Keep track of encoder activity (#11595) 2021-01-21 22:24:07 +11:00
tests Missed a couple more `#pragma once`s (#11351) 2020-12-30 15:44:53 +00:00
tmk_core Keep track of encoder activity (#11595) 2021-01-21 22:24:07 +11:00
users [Keymap] Add peej userspace and keymaps (#11332) 2021-01-19 13:10:28 +11:00
util Merge remote-tracking branch 'origin/master' into develop 2021-01-13 16:13:04 +00:00
.clang-format
.editorconfig
.gitattributes
.gitignore Generate api data on each push (#10609) 2020-10-25 14:48:44 -07:00
.gitmodules
.travis.yml CI: Add workflow for codebase formatting (#7382) 2020-12-10 17:01:51 +00:00
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile Configure keyboard matrix from info.json (#10817) 2020-12-30 10:27:37 -08:00
Vagrantfile
book.json
bootloader.mk Add stm32-dfu and apm32-dfu to bootloader.mk (#11019) 2021-01-20 14:04:21 +11:00
build_full_test.mk Ensure single newline at EOF for core files (#11310) 2020-12-28 04:36:32 +11:00
build_json.mk
build_keyboard.mk move the info.json rules above userspace 2021-01-13 16:01:21 -08:00
build_layout.mk
build_test.mk Ensure single newline at EOF for core files (#11310) 2020-12-28 04:36:32 +11:00
common.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
common_features.mk Rewrite APA102 support (#10894) 2020-12-30 00:28:49 +00:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Configure keyboard matrix from info.json (#10817) 2020-12-30 10:27:37 -08:00
nose2.cfg
readme.md Branch point for 2021 Feb 27 Breaking Change 2020-11-30 03:29:39 -08:00
requirements-dev.txt
requirements.txt validate keyboard data with jsonschema 2021-01-07 21:21:12 -08:00
secrets.tar.enc
setup.cfg Use the schema to eliminate custom code (#11108) 2021-01-09 13:34:14 -08:00
shell.nix allow customizing decrease delay of rgb heatmap (#11322) 2021-01-14 11:29:00 -08:00
show_options.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
testlist.mk Ensure single newline at EOF for core files (#11310) 2020-12-28 04:36:32 +11:00

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.