Go to file
Nick Brassel f3620b9ad0
Branch point for 2023q1 Breaking Change
2022-11-28 07:57:51 +11:00
.github Merge API update workflow (#19121) 2022-11-21 02:03:17 +00:00
.vscode Exclude uf2 files in VS Code (#18186) 2022-08-28 09:59:07 -07:00
builddefs NVRAM refactor, phase 1. (#18969) 2022-11-23 08:50:19 +00:00
data 2022 Nov 26 changelog. (#19164) 2022-11-28 07:33:55 +11:00
docs 2022 Nov 26 changelog. (#19164) 2022-11-28 07:33:55 +11:00
drivers Add default limit to OLED dirty processing (#19068) 2022-11-14 01:49:58 +00:00
keyboards Fix API errors in handwired/tractyl_manuform/5x6_right/arduinomicro (#19166) 2022-11-27 02:07:07 +00:00
layouts Merge remote-tracking branch 'origin/master' into develop 2022-11-15 16:58:09 +00:00
lib Revert lib/usbhost changes (#19165) 2022-11-27 02:05:04 +00:00
platforms NVRAM refactor, phase 1. (#18969) 2022-11-23 08:50:19 +00:00
quantum Fix encoder_init call order in keyboard_init (#19140) 2022-11-27 10:07:35 +11:00
tests Don't clear keys on layer change unless STRICT_LAYER_RELEASE is enabled (#18577) 2022-11-12 02:11:50 +00:00
tmk_core Joystick feature improvements (#19052) 2022-11-27 03:14:45 +11:00
users Change `RGB_MATRIX_STARTUP_*` defines to `RGB_MATRIX_DEFAULT_*` (#19079) 2022-11-27 04:18:24 +11:00
util Fixup installation procedure for different Fedora versions. (#19159) 2022-11-27 04:16:08 +11:00
.clang-format Clang-format tweaks (#15906) 2022-02-11 20:00:34 -08:00
.editorconfig QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
.gitattributes eol=lf, where appropriate (#15752) 2022-01-05 21:56:31 +00:00
.gitignore Merge remote-tracking branch 'origin/master' into develop 2022-11-22 02:48:11 +00:00
.gitmodules [Core] Add Raspberry Pi RP2040 support (#14877) 2022-06-30 13:19:27 +02:00
Dockerfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2021-08-29 16:41:56 -07:00
Doxyfile Internal docs generation updates (#16411) 2022-02-21 15:47:44 +00:00
LICENSE add an explicit lisence file for github to pickup 2017-11-13 20:50:54 -05:00
Makefile Remove .noci functionality (#19122) 2022-11-21 02:03:38 +00:00
Vagrantfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2021-08-29 16:41:56 -07:00
doxygen-todo Remove SERIAL_LINK feature (#14727) 2021-10-07 12:32:05 +11:00
license_GPLv2.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_GPLv3.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_Modified_BSD.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
nose2.cfg Setup a python test framework 2019-09-07 07:58:41 -07:00
paths.mk Remove quantum/audio from global VPATH (#18753) 2022-10-20 14:41:45 +01:00
readme.md Branch point for 2023q1 Breaking Change 2022-11-28 07:57:51 +11:00
requirements-dev.txt Macros in JSON keymaps (#14374) 2021-11-22 11:11:35 -08:00
requirements.txt Align CLI requirements (#18117) 2022-08-21 18:38:17 +01:00
setup.cfg Quantum Painter (#10174) 2022-04-13 18:00:18 +10:00
shell.nix Nix shell updates for `develop` (#18131) 2022-08-23 02:59:33 +01:00

readme.md

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.

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.