Open-source keyboard firmware for Atmel AVR and Arm USB families
Go to file
Joel Challis 17498fa48a
Migrate `led_update_kb` implementations to DD ()
2024-06-22 12:14:07 +01:00
.github Ensure documentation pull requests build () 2024-06-13 02:59:37 +01:00
.vscode Far better VSCode intellisense support using clangd. () 2023-05-14 15:32:34 +10:00
builddefs Generate keymap dd keycodes to header () 2024-06-17 21:51:53 +01:00
data add farsi keymap extras () 2024-06-20 16:12:16 -07:00
docs Remove deprecated `led_set_user` () 2024-06-22 09:10:58 +01:00
drivers APA102: API rework () 2024-06-13 22:19:45 +10:00
keyboards Migrate `led_update_kb` implementations to DD () 2024-06-22 12:14:07 +01:00
layouts Merge remote-tracking branch 'upstream/master' into develop 2024-05-02 20:32:16 +10:00
lib Merge remote-tracking branch 'origin/master' into develop 2024-06-22 03:28:27 +00:00
platforms Decouple VIA from STM32 L0/L1 EEPROM implementation () 2024-06-12 13:00:23 +10:00
quantum Remove deprecated `led_set_user` () 2024-06-22 09:10:58 +01:00
tests Merge remote-tracking branch 'origin/master' into develop 2024-05-13 17:16:21 +00:00
tmk_core [FIX] ChibiOS: USB Digitizer and Joystick IN endpoint compilation () 2024-06-03 22:35:46 +10:00
users Remove symbolic linked userspace folder () 2023-11-27 12:49:44 +11:00
util 2024 Q2 changelog () 2024-05-28 11:48:48 +10:00
.clang-format
.clangd clangd enhancements. () 2024-05-02 20:08:41 +10:00
.editorconfig Normalise .editorconfig. () 2024-03-02 23:23:34 +11:00
.gitattributes
.gitignore Enable 'keyboard.json' as a build target () 2024-03-10 16:20:25 +11:00
.gitmodules
Doxyfile Vitepress conversion of docs. () 2024-05-30 12:00:41 +10:00
LICENSE
Makefile Add helper `make` targets for formatting and pytest. () 2024-06-04 12:23:25 +10:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
nose2.cfg
paths.mk
readme.md Merge remote-tracking branch 'origin/master' into develop 2024-06-22 04:45:34 +00:00
requirements-dev.txt
requirements.txt
setup.cfg
shell.nix Nix shell updates (Nixpkgs 2024-02-23, QMK CLI 1.1.5) () 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.