Go to file
QMK Bot e20bc76a1e Merge remote-tracking branch 'origin/master' into develop 2021-11-23 01:41:28 +00:00
.github Merge remote-tracking branch 'origin/master' into develop 2021-11-23 01:41:28 +00:00
.vscode remove Bracket Pair Colorizer recommendation (#14816) 2021-10-15 11:54:19 +11:00
api_data Generate api data on each push (#10609) 2020-10-25 14:48:44 -07:00
builddefs Add support for deferred executors. (#14859) 2021-11-15 18:21:09 +00:00
data Macros in JSON keymaps (#14374) 2021-11-22 11:11:35 -08:00
docs [Docs] Squeezing space out of AVR (#15243) 2021-11-23 08:14:00 +11:00
drivers Rework and expand Pointing Device support (#14343) 2021-11-14 22:03:24 -08:00
keyboards [Keyboard] Disable features on SplitKB boards to fit under size (#15262) 2021-11-22 17:22:49 -08:00
layouts Require explicit enabling of RGB Matrix modes (#15018) 2021-11-15 10:41:04 -08:00
lib Merge remote-tracking branch 'origin/master' into develop 2021-11-23 00:24:00 +00:00
platforms [Core] RISC-V toolchain and picolibc fixes (#15109) 2021-11-20 20:04:16 +00:00
quantum Revert "[Tests] Increase QMK test coverage (#13789)" 2021-11-23 09:54:04 +11:00
tests Revert "[Tests] Increase QMK test coverage (#13789)" 2021-11-23 09:54:04 +11:00
tmk_core [Bug] Fix timer include in override_wiring.c (#15221) 2021-11-19 21:22:45 +00:00
users Merge remote-tracking branch 'origin/master' into develop 2021-11-17 20:46:24 +00:00
util Merge remote-tracking branch 'origin/master' into develop 2021-11-20 22:01:53 +00:00
.clang-format fix indent size 2019-06-11 01:51:40 -07:00
.editorconfig QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
.gitattributes [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 2021-04-03 08:05:46 -07:00
.gitignore New CLI subcommand to create clang-compatible compilation database (`compile_commands.json`) (#14370) 2021-09-16 14:59:57 +10:00
.gitmodules Purge uGFX. (#14720) 2021-10-07 10:57:48 +11:00
Dockerfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2021-08-29 16:41:56 -07:00
Doxyfile Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
LICENSE add an explicit lisence file for github to pickup 2017-11-13 20:50:54 -05:00
Makefile Revert "[Tests] Increase QMK test coverage (#13789)" 2021-11-23 09:54:04 +11:00
Vagrantfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2021-08-29 16:41:56 -07:00
book.json adds redirects for docs 2017-08-19 08:31:54 -04:00
build_full_test.mk Revert "[Tests] Increase QMK test coverage (#13789)" 2021-11-23 09:54:04 +11:00
build_json.mk Add config.h and rules.mk support for data driven keymaps (#12859) 2021-08-18 21:52:41 +01:00
build_keyboard.mk Move tmk_core/common/<plat> (#13918) 2021-11-19 10:41:02 -08:00
build_layout.mk Add config.h and rules.mk support for data driven keymaps (#12859) 2021-08-18 21:52:41 +01:00
build_test.mk Revert "[Tests] Increase QMK test coverage (#13789)" 2021-11-23 09:54:04 +11:00
common_features.mk Move tmk_core/common/<plat> (#13918) 2021-11-19 10:41:02 -08:00
doxygen-todo Remove SERIAL_LINK feature (#14727) 2021-10-07 12:32:05 +11: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
nose2.cfg Setup a python test framework 2019-09-07 07:58:41 -07:00
paths.mk Move tmk_core/common/<plat> (#13918) 2021-11-19 10:41:02 -08:00
readme.md [Core] [Docs] Remove travis-ci references (#13916) 2021-08-20 23:31:26 +01:00
requirements-dev.txt Macros in JSON keymaps (#14374) 2021-11-22 11:11:35 -08:00
requirements.txt switch to qmk-dotty-dict (#13460) 2021-07-14 09:08:48 -07:00
setup.cfg Use the schema to eliminate custom code (#11108) 2021-01-09 13:34:14 -08:00
shell.nix Remove bin/qmk (#14231) 2021-08-29 16:50:22 -07:00
testlist.mk Revert "[Tests] Increase QMK test coverage (#13789)" 2021-11-23 09:54:04 +11: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.