Go to file
Albert Y 64acbcb42a
[Docs] Building with GitHub Userspace (#16271)
2022-08-06 16:36:31 +10:00
.github Add reviewer/labels to dependabot PRs (#17743) 2022-07-21 21:24:07 +01:00
.vscode remove Bracket Pair Colorizer recommendation (#14816) 2021-10-15 11:54:19 +11:00
builddefs Added support for Wb32fq95 (#16871) 2022-05-23 15:57:24 +10:00
data Promote label with newlines to lint error (#17347) 2022-06-10 11:44:23 +01:00
docs [Docs] Building with GitHub Userspace (#16271) 2022-08-06 16:36:31 +10:00
drivers Change AW20216 SPI Mode from 0 to 3, to fix RGB LEDs on GMMK Pro (#17262) 2022-05-31 14:46:21 +10:00
keyboards [Keyboard] Add Crin PCB (#17913) 2022-08-05 23:31:05 -07:00
layouts jotix's community ortho_4x12 layout change (#17891) 2022-08-03 11:32:23 +01:00
lib CLI compatibility for MacOS (#17811) 2022-07-27 10:29:10 +01:00
platforms [Split] Ensure SOFT_SERIAL_PIN is defined if USE_I2C isn't defined (#17466) 2022-06-25 12:34:40 -07:00
quantum Fix check when compiling HID Joystick with digital driver (#17844) 2022-07-30 01:32:06 +01:00
tests Apply EXPECT_REPORT and EXPECT_EMPTY_REPORT (#17311) 2022-06-05 20:06:05 +01:00
tmk_core Check for ongoing transfers on the OUT endpoint (#16974) 2022-05-14 23:17:14 +01:00
users Userspace: muppetjones (#1) (#13461) 2022-08-03 18:23:17 +01:00
util MSYS2 install: use MinGW python-qmk package (#17302) 2022-07-02 15:08:05 +01:00
.clang-format Clang-format tweaks (#15906) 2022-02-11 20:00:34 -08:00
.editorconfig
.gitattributes eol=lf, where appropriate (#15752) 2022-01-05 21:56:31 +00:00
.gitignore Add .orig to .gitignore (#17626) 2022-07-17 04:38:56 +10:00
.gitmodules
Dockerfile
Doxyfile Internal docs generation updates (#16411) 2022-02-21 15:47:44 +00:00
LICENSE
Makefile Migrate more makefile utilities to builddefs sub-directory (#16002) 2022-02-10 09:45:51 -08:00
Vagrantfile
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
nose2.cfg
paths.mk Migrate more makefile utilities to builddefs sub-directory (#16002) 2022-02-10 09:45:51 -08:00
readme.md Merge point for 2022-05-28 Breaking Change 2022-05-29 07:53:50 +10:00
requirements-dev.txt Macros in JSON keymaps (#14374) 2021-11-22 11:11:35 -08:00
requirements.txt Quantum Painter (#10174) 2022-04-13 18:00:18 +10:00
setup.cfg Quantum Painter (#10174) 2022-04-13 18:00:18 +10:00
shell.nix Remove Nixpkgs-provided `poetry` from the environment (#17673) 2022-07-18 22:52:55 +03: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.