Open-source keyboard firmware for Atmel AVR and Arm USB families. Mirror of https://github.com/qmk/qmk_firmware
Go to file
Joel Challis faf77f1651
Fix typo in Battery Driver docs (#25312)
* Fix typo in Battery Driver docs

* Update battery.md
2025-05-28 16:05:44 +10:00
.github Merge remote-tracking branch 'origin/master' into develop 2025-04-23 02:03:39 +00:00
.vscode Use relative paths for schemas, instead of $id. Enables VScode validation. (#25251) 2025-05-19 22:10:39 +10:00
builddefs Bump vite from 5.4.18 to 5.4.19 in /builddefs/docsgen (#25306) 2025-05-27 18:07:22 +01:00
data Move rookiebwoy to ivndbt (#25142) 2025-05-19 22:15:19 +01:00
docs Fix typo in Battery Driver docs (#25312) 2025-05-28 16:05:44 +10:00
drivers Add compiler_support.h (#25274) 2025-05-22 23:31:15 +10:00
keyboards Fix Sofle OLED layer indication code (#25311) 2025-05-27 18:47:00 -06:00
layouts Merge remote-tracking branch 'origin/master' into develop 2025-03-20 21:55:29 +00:00
lib Add compiler_support.h (#25274) 2025-05-22 23:31:15 +10:00
modules/qmk Enable community modules to define LED matrix and RGB matrix effects. (#25187) 2025-05-12 09:30:19 +10:00
platforms Add compiler_support.h (#25274) 2025-05-22 23:31:15 +10:00
quantum Fix reference to wrong layer when LM used with right modifiers (#25303) 2025-05-27 23:24:20 +01:00
tests [Core] Enhance Flow Tap to work better for rolls over multiple tap-hold keys. (#25200) 2025-04-28 09:52:20 +02:00
tmk_core Add compiler_support.h (#25274) 2025-05-22 23:31:15 +10:00
users Add EOL to non-keyboard files (#24990) 2025-03-06 23:17:51 +00:00
util Remove outdated nix support due to bit-rot. (#25280) 2025-05-21 07:17:58 +10:00
.clang-format Clang-format tweaks (#15906) 2022-02-11 20:00:34 -08:00
.clangd Fix for .clangd. (#25180) 2025-04-22 00:02:47 +10:00
.editorconfig .editorconfig: fix inline comment, tidy name section for yaml (#24416) 2024-09-21 19:48:31 +01:00
.gitattributes eol=lf, where appropriate (#15752) 2022-01-05 21:56:31 +00:00
.gitignore Add via keymaps to gitignore (#24329) 2024-08-26 04:33:40 +01:00
.gitmodules [Core] Quantum Painter - LVGL Integration (#18499) 2022-12-13 07:51:14 +11:00
Doxyfile Remove arm_atsam platform (#24337) 2024-09-02 03:48:17 +01:00
doxygen-todo Remove SERIAL_LINK feature (#14727) 2021-10-07 12:32:05 +11:00
LICENSE add an explicit lisence file for github to pickup 2017-11-13 20:50:54 -05: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
Makefile gcc15 AVR compilation fixes (#25238) 2025-05-19 09:22:31 +10: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 2025 Q2 changelog (#25297) 2025-05-26 21:04:52 +10:00
requirements-dev.txt Macros in JSON keymaps (#14374) 2021-11-22 11:11:35 -08:00
requirements.txt Align to latest CLI dependencies (#24553) 2025-03-20 14:04:10 +11:00
setup.cfg Quantum Painter (#10174) 2022-04-13 18:00:18 +10:00

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.