Go to file
Sadek Baroudi ced1cb7e3b ximi proto default bootloader added to left half for easy flashing 2024-08-03 12:48:14 -07:00
.github allow manual triggering of build workflow 2024-08-01 19:20:59 -07:00
.vscode
bin pinkies out v3.1 firmware 2024-07-10 21:29:00 -07:00
builddefs
data keyboard.json schema: set minimum value for `key_unit` (#23937) 2024-06-16 21:57:37 +01:00
docs Update documentation suggestion in top level readme (#23978) 2024-06-22 05:45:04 +01:00
drivers
keyboards ximi proto default bootloader added to left half for easy flashing 2024-08-03 12:48:14 -07:00
layouts
lib Add support for userspace to docker build commands. (#23988) 2024-06-24 12:29:30 +10:00
platforms
quantum Merge tag '0.25.9' into develop_fingerpunch 2024-08-01 19:14:17 -07:00
tests
tmk_core
users better generic vik support to handle all modules in one go, testing out with ximega 2024-06-25 16:07:26 -07:00
util Add support for userspace to docker build commands. (#23988) 2024-06-24 12:29:30 +10:00
.clang-format
.clangd
.editorconfig
.gitattributes
.gitignore Merge tag '0.25.9' into develop_fingerpunch 2024-08-01 19:14:17 -07:00
.gitmodules
Doxyfile
LICENSE
Makefile
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
nose2.cfg
paths.mk
readme.md Update documentation suggestion in top level readme (#23978) 2024-06-22 05:45:04 +01:00
requirements-dev.txt
requirements.txt
setup.cfg
shell.nix

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 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.