Go to file
AlanLiu f0e219a1c8
Modify wording in 'getting_started_introduction.md' (#23232)
Co-authored-by: Joel Challis <git@zvecr.com>
2024-03-14 19:00:03 -07:00
.github Bump tj-actions/changed-files from 42 to 43 (#23282) 2024-03-15 01:44:32 +00:00
.vscode Far better VSCode intellisense support using clangd. (#20382) 2023-05-14 15:32:34 +10:00
builddefs [Core] Allow ChibiOS SIO driver for UART driver (#22839) 2024-02-20 11:34:24 +01:00
data Add LED/RGB Matrix drivers to info.json schema (#23127) 2024-02-25 21:29:25 +00:00
docs Modify wording in 'getting_started_introduction.md' (#23232) 2024-03-14 19:00:03 -07:00
drivers IS31FL3729 updates (#23109) 2024-02-22 17:51:49 +11:00
keyboards AMJKeyboard AMJ96 Layout Additions (#23267) 2024-03-14 18:32:17 -07:00
layouts Add 5x13 and 6x13 ortho community layouts (#22315) 2023-11-28 22:56:17 -08:00
lib Absolute paths for -kb argument should error consistently (#23262) 2024-03-13 00:28:08 +00:00
platforms Attempt to deal with GCC 13+ and rv32 arch extensions. (#23086) 2024-03-09 21:40:19 +11:00
quantum Fixes for encoder abstraction. (#23195) 2024-03-10 22:24:17 +11:00
tests Ignore space cadet key release when caps word is active (#21721) 2024-01-09 22:07:10 +11:00
tmk_core Update GPIO macro usages in core (#23093) 2024-02-18 17:08:27 +11:00
users Remove symbolic linked userspace folder (#22548) 2023-11-27 12:49:44 +11:00
util Update Atmel DFU driver assignments for dfu-programmer 1.x (#23165) 2024-02-28 21:03:43 +11: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 Normalise .editorconfig. (#23186) 2024-03-02 23:23:34 +11:00
.gitattributes eol=lf, where appropriate (#15752) 2022-01-05 21:56:31 +00:00
.gitignore Add more unwanted compilation output files to .gitignore. (#22894) 2024-01-12 12:08:11 +00: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
doxygen-todo Remove SERIAL_LINK feature (#14727) 2021-10-07 12:32:05 +11:00
LICENSE add an explicit lisence file for github to pickup 2017-11-13 20:50:54 -05:00
license_GPLv2.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_GPLv3.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_Modified_BSD.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
Makefile Fix unit test execution (#23048) 2024-02-12 01:19:40 +00:00
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 Merge point for 2024q1 Breaking Change 2024-02-28 21:46:31 +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 (Nixpkgs 2024-02-23, QMK CLI 1.1.5) (#23143) 2024-02-26 13:04:27 +11:00

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.