Open-source keyboard firmware for Atmel AVR and Arm USB families
Go to file
katanova 292e0e0a15 testing laptop 2024-03-04 13:07:56 -08:00
.github Bump tj-actions/changed-files from 41 to 42 (#22915) 2024-01-18 20:15:48 +00:00
.vscode Far better VSCode intellisense support using clangd. (#20382) 2023-05-14 15:32:34 +10:00
builddefs Fix TARGET when using converters (#22591) 2023-12-08 20:55:24 +11:00
data Sort defaults.hjson (#22587) 2023-12-04 12:04:21 +11:00
docs add pywinusb lib to list of example libs for HID (#22747) 2024-01-09 22:13:51 +11:00
drivers Azoteq IQS5xx support (#22280) 2023-11-20 16:25:35 +00:00
keyboards testing laptop 2024-03-04 13:07:56 -08:00
layouts Remove userspace keymaps (#22544) 2023-11-27 05:36:45 +11:00
lib Move layout macro OOB checks to lint (#22610) 2024-01-22 11:35:51 +00:00
platforms Cater for ECC failures in EFL wear-leveling. (#19749) 2023-11-26 22:59:38 +11:00
quantum Fix user hook call for dynamic_macro_record_key (#22250) 2024-01-09 21:45:44 +11:00
tests Regenerate Files (#22821) 2024-01-04 08:59:38 +00:00
tmk_core Fix missing joystick.h include (#22946) 2024-01-22 13:18:20 +00:00
users Remove symbolic linked userspace folder (#22548) 2023-11-27 12:49:44 +11:00
util Workaround for dfu-programmer on Fedora 39 (#22945) 2024-01-23 10:02:03 +00:00
.clang-format Clang-format tweaks (#15906) 2022-02-11 20:00:34 -08:00
.clangd Far better VSCode intellisense support using clangd. (#20382) 2023-05-14 15:32:34 +10:00
.editorconfig QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
.gitattributes eol=lf, where appropriate (#15752) 2022-01-05 21:56:31 +00:00
.gitignore Add more unwanted compilation output files to `.gitignore`. (#22894) 2024-01-12 12:08:11 +00:00
.gitmodules [Core] Quantum Painter - LVGL Integration (#18499) 2022-12-13 07:51:14 +11:00
Doxyfile Internal docs generation updates (#16411) 2022-02-21 15:47:44 +00:00
LICENSE add an explicit lisence file for github to pickup 2017-11-13 20:50:54 -05:00
Makefile QMK Userspace (#22222) 2023-11-28 07:53:43 +11: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 Remove notice about `develop`. 2023-11-28 15:56:54 +11: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 for `develop` (#18131) 2022-08-23 02:59:33 +01: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 Docsify and hosted on GitHub. 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, or by clicking the "Edit this page" link at the bottom of any page.

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.