Open-source keyboard firmware for Atmel AVR and Arm USB families. Mirror of https://github.com/qmk/qmk_firmware
 
 
 
 
Go to file
QMK Bot fef8e7195b Merge remote-tracking branch 'origin/master' into develop 2024-07-15 08:42:14 +00:00
.github [CI] Disable Discord webhook when CI run is cancelled. (#24104) 2024-07-12 01:19:33 +01:00
.vscode Far better VSCode intellisense support using clangd. (#20382) 2023-05-14 15:32:34 +10:00
builddefs [docs] Fixup home link. (#24068) 2024-07-06 16:19:00 +10:00
data [Keyboard] Rename dnworks/9973 to dnworks/tkl87 (#23692) 2024-07-11 14:40:54 +01:00
docs LED drivers: extract documentation from LED/RGB Matrix pages (#23630) 2024-07-15 12:03:30 +10:00
drivers Normalise mouse keycodes (#23975) 2024-07-03 18:35:54 +10:00
keyboards Merge remote-tracking branch 'origin/master' into develop 2024-07-15 08:42:14 +00:00
layouts Merge remote-tracking branch 'upstream/master' into develop 2024-05-02 20:32:16 +10:00
lib Merge remote-tracking branch 'origin/master' into develop 2024-07-03 12:01:26 +00:00
platforms Allow overriding `get_hardware_id()`. (#24051) 2024-07-05 11:22:08 +10:00
quantum Update atomic GPIO macros in keyboard custom matrix (#23796) 2024-07-13 18:41:05 +10:00
tests Tap dance introspection (#24049) 2024-07-06 00:57:54 +01:00
tmk_core Align LUFA suspend logic (#24055) 2024-07-05 12:02:39 +01:00
users Remove symbolic linked userspace folder (#22548) 2023-11-27 12:49:44 +11:00
util [CI] Disable Discord webhook when CI run is cancelled. (#24104) 2024-07-12 01:19:33 +01:00
.clang-format Clang-format tweaks (#15906) 2022-02-11 20:00:34 -08:00
.clangd clangd enhancements. (#23310) 2024-05-02 20:08:41 +10:00
.editorconfig Normalise .editorconfig. (#23186) 2024-03-02 23:23:34 +11:00
.gitattributes eol=lf, where appropriate (#15752) 2022-01-05 21:56:31 +00:00
.gitignore Add json index of files to CI uploads (#24097) 2024-07-12 08:48:43 +10:00
.gitmodules [Core] Quantum Painter - LVGL Integration (#18499) 2022-12-13 07:51:14 +11:00
Doxyfile Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
LICENSE add an explicit lisence file for github to pickup 2017-11-13 20:50:54 -05:00
Makefile Add helper `make` targets for formatting and pytest. (#23858) 2024-06-04 12:23:25 +10: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 Merge remote-tracking branch 'origin/master' into develop 2024-06-22 04:45:34 +00: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 (Nixpkgs 2024-02-23, QMK CLI 1.1.5) (#23143) 2024-02-26 13:04:27 +11: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 VitePress. 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.

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.