Go to file
Joel Challis 53680fa6da
Fix g_led_config parse warning (#24769)
2025-01-01 01:58:41 +00: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
builddefs Set custom effect defines for LED Matrix (#24745) 2024-12-24 10:26:08 -08:00
data fix: KC_MEDIA_PLAY_PAUSE label (#24693) 2024-12-08 22:44:12 -07:00
docs Clarify keymap location and format in newbs_building_firmware.md (#24663) 2024-12-22 12:23:14 -08:00
drivers
keyboards Remove invalid "effect_max" animation from keyboards (#24767) 2024-12-31 12:36:24 +00:00
layouts Organise default community layouts summary (#24500) 2024-12-07 09:05:40 +11:00
lib Fix g_led_config parse warning (#24769) 2025-01-01 01:58:41 +00:00
platforms Bring supported STM32F4 configs in line with F4x1 (#24413) 2024-11-21 22:54:01 +11:00
quantum Provide method to save a single default layer in the full range of 0-31 (#24639) 2024-11-25 07:35:21 +11:00
tests Add pointing tests (#24513) 2024-11-23 16:34:32 +00:00
tmk_core
users
util Add ArteryTek AT32 dfu to udev rules (#24747) 2024-12-25 02:57:30 +00:00
.clang-format
.clangd
.editorconfig
.gitattributes
.gitignore
.gitmodules
Doxyfile
LICENSE
Makefile
doxygen-todo
license_GPLv2.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_GPLv3.md
license_Modified_BSD.md
nose2.cfg
paths.mk
readme.md Merge point for 2024q4 breaking change. 2024-11-27 21:26:34 +11:00
requirements-dev.txt
requirements.txt
setup.cfg
shell.nix

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.