Go to file
Sadek Baroudi 9756df8b16 Merge remote-tracking branch 'origin/develop_fingerpunch' 2026-04-19 10:38:24 -07:00
.github reverting back to previous qmk cli docker image, new one broke my builds 2024-11-30 00:56:54 -08:00
.vscode Far better VSCode intellisense support using clangd. (#20382) 2023-05-14 15:32:34 +10:00
bin pinkies out v3.1 firmware 2024-07-10 21:29:00 -07:00
builddefs [docs] Add ability to redirect based on input path. (#23851) 2024-06-03 08:55:03 +10:00
data keyboard.json schema: set minimum value for `key_unit` (#23937) 2024-06-16 21:57:37 +01:00
docs Update documentation suggestion in top level readme (#23978) 2024-06-22 05:45:04 +01:00
drivers Fix PS/2 Trackpoint mouse clicks (#22265) (#23694) 2024-05-21 00:36:48 +01:00
keyboards Fix acceleration toggle on key press to trigger only when key is actually pressed 2026-03-26 09:22:02 -07:00
layouts Merge remote-tracking branch 'upstream/master' into develop 2024-05-02 20:32:16 +10:00
lib Add support for userspace to docker build commands. (#23988) 2024-06-24 12:29:30 +10:00
platforms Re-implement `eeprom_write_qword` as define (#23890) 2024-06-10 01:23:25 +01:00
quantum Merge tag '0.25.9' into develop_fingerpunch 2024-08-01 19:14:17 -07:00
tests Merge remote-tracking branch 'origin/master' into develop 2024-05-13 17:16:21 +00:00
tmk_core [FIX] ChibiOS: USB Digitizer and Joystick IN endpoint compilation (#23854) 2024-06-03 22:35:46 +10:00
users tapping term fix for my personal boards 2025-04-25 15:13:40 -07:00
util Add support for userspace to docker build commands. (#23988) 2024-06-24 12:29:30 +10: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 Merge tag '0.25.9' into develop_fingerpunch 2024-08-01 19:14:17 -07: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 Update documentation suggestion in top level readme (#23978) 2024-06-22 05:45:04 +01: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

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.