Open-source keyboard firmware for Atmel AVR and Arm USB families. Mirror of https://github.com/qmk/qmk_firmware
 
 
 
 
Go to file
QMK Bot 65b5dc7e0f Merge remote-tracking branch 'origin/master' into develop 2024-10-06 08:40:06 +00:00
.github Bump JamesIves/github-pages-deploy-action from 4.6.4 to 4.6.8 (#24453) 2024-09-30 20:31:03 +01:00
.vscode Far better VSCode intellisense support using clangd. (#20382) 2023-05-14 15:32:34 +10:00
builddefs WS2812 API rework (#24364) 2024-10-06 21:01:07 +13:00
data These should really have been 0.0.6. 2024-08-27 10:55:32 +10:00
docs Add easier way to set default single layer (#24376) 2024-10-06 21:39:21 +13:00
drivers WS2812 API rework (#24364) 2024-10-06 21:01:07 +13:00
keyboards WS2812 API rework (#24364) 2024-10-06 21:01:07 +13:00
layouts Remove `60_tsangan_hhkb` community layout (#24355) 2024-09-05 15:21:45 +10:00
lib Merge remote-tracking branch 'origin/master' into develop 2024-09-13 20:53:01 +00:00
platforms WS2812 API rework (#24364) 2024-10-06 21:01:07 +13:00
quantum Add easier way to set default single layer (#24376) 2024-10-06 21:39:21 +13:00
tests Remove `RING_BUFFERED_6KRO_REPORT_ENABLE` due to disuse. (#24433) 2024-09-24 12:53:55 +01:00
tmk_core Remove `RING_BUFFERED_6KRO_REPORT_ENABLE` due to disuse. (#24433) 2024-09-24 12:53:55 +01:00
users Remove symbolic linked userspace folder (#22548) 2023-11-27 12:49:44 +11:00
util Merge remote-tracking branch 'origin/master' into develop 2024-10-06 08:40:06 +00: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 Branch point for 2024q4 breaking change 2024-08-26 10:04:37 +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

readme.md

THIS IS THE DEVELOP BRANCH

Warning- This is the develop branch of QMK Firmware. You may encounter broken code here. Please see Breaking Changes for more information.

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.