Go to file
amsleaveamix f4a480a347 cl-parsons new-keymap 2023-12-09 10:42:38 +01:00
.github Add `qmk ci-validate-aliases` (#22205) 2023-10-06 10:34:23 +11:00
.vscode Far better VSCode intellisense support using clangd. (#20382) 2023-05-14 15:32:34 +10:00
builddefs Fixup symbol sizing listing. (#22307) 2023-10-21 21:31:23 +11:00
data Add `qmk ci-validate-aliases` (#22205) 2023-10-06 10:34:23 +11:00
docs Clarify PIO define is optional in docs. (#22339) 2023-10-26 22:34:17 +01:00
drivers Fix typo in oled_driver (#22134) 2023-09-25 20:40:27 +01:00
keyboards cl-parsons new-keymap 2023-12-09 10:42:38 +01:00
layouts Add `60_iso_tsangan_split_bs_rshift` Community Layout (#21812) 2023-10-12 01:12:50 -07:00
lib Allow for disabling of parallel processing of qmk find and `qmk mass-compile`. (#22160) 2023-10-17 09:43:50 +11:00
platforms Fix entry into bootloader for STM32G431. (#22138) 2023-09-26 12:20:32 +10:00
quantum Remove extra led_matrix_indicators_user call (#22329) 2023-10-24 00:00:16 +01:00
tests Unicode, Unicodemap and UCIS refactor (#21659) 2023-08-27 13:30:19 +10:00
tmk_core Revert changes to ChibiOS Suspend Code (#21830) 2023-08-27 03:52:12 +01:00
users Update to 'peterfalken' userspace configurations (#21836) 2023-09-14 13:08:00 +10:00
util Update macOS install script (#21854) 2023-09-01 09:26:48 +10: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 Flag vial keymaps in 'qmk lint' (#22227) 2023-10-08 12:45:13 +01: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 Unicode, Unicodemap and UCIS refactor (#21659) 2023-08-27 13:30:19 +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 Remove develop notice. 2023-08-29 21:19:06 +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 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.