⌨️ Open-source keyboard firmware for Atmel AVR and Arm USB families
Find a file
2024-09-18 15:46:13 +01:00
.github Update PR template (#24397) 2024-09-14 16:09:01 -06:00
.vscode Far better VSCode intellisense support using clangd. (#20382) 2023-05-14 15:32:34 +10:00
builddefs Bump vite from 5.2.10 to 5.2.14 in /builddefs/docsgen (#24403) 2024-09-18 09:56:46 +01:00
data [Keyboard] Move Planck EZ to ZSA vendor folder (#23917) 2024-08-14 14:27:37 +01:00
docs [Docs] Remove references to bootmagic lite (#24369) 2024-09-06 17:30:54 +01:00
drivers Fix ADNS-9800 read (#24406) 2024-09-18 15:46:13 +01:00
keyboards [Keyboard] Styrka Atmel Custom PCB (#24380) 2024-09-12 22:58:02 -06:00
layouts Add 60_ansi_tsangan_split_bs_rshift to community layouts (#24186) 2024-09-02 09:13:28 +10:00
lib qmk find: Fix handling of keys with dots in filter functions (#24393) 2024-09-14 06:52:31 +10:00
platforms Workaround for broken STM32L433 startup (#24404) 2024-09-18 19:06:50 +10:00
quantum Enhance overlapping mouse keys control (#23341) 2024-08-19 03:18:28 +01:00
tests Tap dance introspection (#24049) 2024-07-06 00:57:54 +01:00
tmk_core Fix NKRO and Mouse Emulation on arm_atsam (#23945) 2024-08-13 09:06:24 +10:00
users Remove symbolic linked userspace folder (#22548) 2023-11-27 12:49:44 +11:00
util Fix version check in Fedora install script to be >= 39 (#24281) 2024-08-15 12:10:35 +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 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 Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10: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 Add helper make targets for formatting and pytest. (#23858) 2024-06-04 12:23:25 +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 Merge point for 2024q3 breaking change 2024-08-26 09:49:08 +10: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

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.