Open-source keyboard firmware for Atmel AVR and Arm USB families
Go to file
dependabot[bot] ea3a968510
Bump vite from 5.2.14 to 5.4.12 in /builddefs/docsgen (#24852)
2025-01-30 06:20:08 +11:00
.github Bump JamesIves/github-pages-deploy-action from 4.7.1 to 4.7.2 (#24672) 2024-12-03 19:31:16 +00:00
.vscode Far better VSCode intellisense support using clangd. (#20382) 2023-05-14 15:32:34 +10:00
builddefs Bump vite from 5.2.14 to 5.4.12 in /builddefs/docsgen (#24852) 2025-01-30 06:20:08 +11:00
data fix: KC_MEDIA_PLAY_PAUSE label (#24693) 2024-12-08 22:44:12 -07:00
docs [License Violation] add pressplayid (#24869) 2025-01-25 08:58:38 -07:00
drivers Move pointing device driver code (#24445) 2024-10-25 18:11:51 +01:00
keyboards Add keyboard clap_studio/flame60 (#24870) 2025-01-26 09:25:15 -07:00
layouts Organise default community layouts summary (#24500) 2024-12-07 09:05:40 +11:00
lib Reject keyboard.json next to info.json (#24882) 2025-01-30 06:17:29 +11:00
platforms Remove preprocessor sanity check for STM32L0/L1 now that it relies on types in C. (#24793) 2025-01-07 08:48:28 +11:00
quantum Fix missing wait.h include in Dip Switch Map (#24863) 2025-01-25 03:11:38 +00:00
tests [CI] Regenerate Files (#24770) 2025-01-01 13:02:16 +11:00
tmk_core Joystick: add support for 8-way hat switch (#24515) 2024-11-09 14:10:10 -08:00
users Remove symbolic linked userspace folder (#22548) 2023-11-27 12:49:44 +11:00
util Allow running Docker container on MacOS (without in-container USB support) (#24412) 2025-01-16 06:36:20 +11: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 `.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
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 point for 2024q4 breaking change. 2024-11-27 21:26:34 +11:00
requirements-dev.txt Macros in JSON keymaps (#14374) 2021-11-22 11:11:35 -08:00
requirements.txt Remove `appdirs` from `requirements.txt` (#24550) 2024-10-30 05:43:31 +00: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.