Go to file
Luis Garcia e67a4ba7ce
Update to 'peterfalken' userspace configurations (#21836)
2023-09-14 13:08:00 +10:00
.github Bump actions/checkout from 3 to 4 (#21907) 2023-09-05 18:50:04 +01:00
.vscode Far better VSCode intellisense support using clangd. (#20382) 2023-05-14 15:32:34 +10:00
builddefs Remove oversize binaries (#21976) 2023-09-12 02:55:05 +01:00
data Add *_MATRIX_LED_COUNT generation (#21110) 2023-08-27 04:00:14 +01:00
docs [Docs] Improve contrast for warnings in dark mode (#21928) 2023-09-05 19:00:14 -07:00
drivers RGB Matrix: driver naming cleanups (#21594) 2023-08-23 01:00:03 +01:00
keyboards Kopibeng XT87 Layout Additions & Touch-Up (#22002) 2023-09-13 19:43:31 -07:00
layouts Revert "fix 60_hhkb ASCII diagram (#21813)" (#21869) 2023-08-30 01:47:15 +01:00
lib Add *_MATRIX_LED_COUNT generation (#21110) 2023-08-27 04:00:14 +01:00
platforms Revert changes to ChibiOS Suspend Code (#21830) 2023-08-27 03:52:12 +01:00
quantum Fix compilation of dynamic_keymap.c without VIA (#21858) 2023-08-29 14:28:09 +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 chore: ignore virtual environment directory (#20905) 2023-09-03 02:24:57 +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
license_GPLv3.md
license_Modified_BSD.md
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.