Go to file
Sadek Baroudi 33818ac694 moved generic rules.mk configuration for converting to svlinky or xivik into general fingerpunch rules.mk 2024-05-27 22:52:20 -07:00
.github
.vscode
bin
builddefs
data
docs [Doc] Use number indexes for encoder code example (#22980) 2024-01-29 19:28:23 +00:00
drivers
keyboards moved generic rules.mk configuration for converting to svlinky or xivik into general fingerpunch rules.mk 2024-05-27 22:52:20 -07:00
layouts
lib
platforms WS2812: Better error message when trying to use `bitbang` driver on RP2040 (#23025) 2024-02-06 08:09:22 +01:00
quantum Merge tag '0.23.9' into develop_fingerpunch 2024-03-01 02:28:31 -08:00
tests
tmk_core
users
util
.clang-format Clang-format tweaks (#15906) 2022-02-11 20:00:34 -08:00
.clangd
.editorconfig QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
.gitattributes
.gitignore Merge tag '0.23.9' into develop_fingerpunch 2024-03-01 02:28:31 -08:00
.gitmodules [Core] Quantum Painter - LVGL Integration (#18499) 2022-12-13 07:51:14 +11:00
Doxyfile
LICENSE
Makefile
doxygen-todo
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
readme.md Removed clueboard link as the website has been parked for some time (#22290) 2023-10-28 16:25:30 +11:00
requirements-dev.txt
requirements.txt
setup.cfg
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.