Go to file
Albert Y e1afcda1c0
Update code example to match description (#20528)
2023-04-23 12:56:45 -06:00
.github Bump anothrNick/github-tag-action from 1.61.0 to 1.62.0 (#20407) 2023-04-10 23:49:53 +01:00
.vscode Exclude uf2 files in VS Code (#18186) 2022-08-28 09:59:07 -07:00
builddefs Add step summary output to CI builds, with failure logs. (#20288) 2023-03-29 15:55:31 +11:00
data Update keycodes_0.0.1_basic.hjson (#20129) 2023-03-16 00:37:58 +00:00
docs Update code example to match description (#20528) 2023-04-23 12:56:45 -06:00
drivers Remove usages of config_common.h from config.h files. (#19714) 2023-01-31 06:03:30 +11:00
keyboards NK Plus (#20392) 2023-04-21 14:55:54 +01:00
layouts [Keymap] Drashna updates for 0.20.0 (#19960) 2023-02-28 11:14:48 -08:00
lib Add autocomplete to generate-compilation-database (#20387) 2023-04-09 17:41:30 +01:00
platforms Add rp2040_ce and add elite-pi and helios as alias (#19830) 2023-02-12 23:02:05 +00:00
quantum [Bugfix] Check QGF's bpp against display's native_bits_per_pixel (#19995) 2023-04-03 12:42:46 +10:00
tests VIA Protocol 12 + fixes (#19916) 2023-02-23 09:19:00 +11:00
tmk_core Move `KC_MISSION_CONTROL`/`KC_LAUNCHPAD` keycodes to core (#19884) 2023-02-19 18:59:50 +11:00
users Add peterfalken userspace & keymaps (#19897) 2023-04-05 12:35:34 -06:00
util Add Discord webhook at end of each CI run. (#20355) 2023-04-07 16:37:06 +10:00
.clang-format Clang-format tweaks (#15906) 2022-02-11 20:00:34 -08: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 Reject info.json at keymap level (#20408) 2023-04-11 02:43:45 +01:00
.gitmodules [Core] Quantum Painter - LVGL Integration (#18499) 2022-12-13 07:51:14 +11:00
Dockerfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2021-08-29 16:41:56 -07:00
Doxyfile Internal docs generation updates (#16411) 2022-02-21 15:47:44 +00:00
LICENSE
Makefile Remove `make all-<platform>` build targets (#19496) 2023-01-19 10:44:41 +11:00
Vagrantfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2021-08-29 16:41:56 -07: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 Breaking Changes 2023q1 changelog. (#19945) 2023-02-27 08:41:42 +11: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.