Go to file
tangowithfoxtrot b66b911fa2
[Keyboard] Fix minor typo in Ploopy Trackball Mini Docs (#14845)
2021-12-07 12:01:16 -08: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
builddefs Westberrytech pr (#14422) 2021-11-27 09:28:18 +11:00
data Tidy up `SLEEP_LED_ENABLE` rules (#15362) 2021-12-01 21:13:00 +11:00
docs [Docs] Reorder functions in Understanding QMK (#15357) 2021-11-30 11:24:21 -08:00
drivers Tidy up adjustable ws2812 timing (#15299) 2021-11-25 19:35:06 +00:00
keyboards [Keyboard] Fix minor typo in Ploopy Trackball Mini Docs (#14845) 2021-12-07 12:01:16 -08:00
layouts Extended Community Layout Support (#15371) 2021-12-06 22:36:02 -08:00
lib Fix 'format-c --core-only' matching keyboard level folders (#15337) 2021-11-29 15:08:39 +00:00
platforms Modified config.h default configuration (#15387) 2021-12-06 06:52:08 +11:00
quantum Fix bit loss in cie_lightness() when doing division to resolve #15331 (#15344) 2021-11-29 15:07:36 +00:00
tests [Tests] Increase QMK test coverage take 2 (#15269) 2021-11-23 13:31:01 +11:00
tmk_core Add missing virtser_init() to ChibiOS code (#15356) 2021-11-30 16:54:18 +11:00
users Remove deprecated defines from my keymaps (#15353) 2021-11-30 16:45:08 +11:00
util Add script for performing compilation size regression investigations. (#15303) 2021-11-27 09:11:03 +11:00
.clang-format
.editorconfig
.gitattributes
.gitignore
.gitmodules
Dockerfile
Doxyfile
LICENSE
Makefile [Tests] Increase QMK test coverage take 2 (#15269) 2021-11-23 13:31:01 +11:00
Vagrantfile
book.json
build_full_test.mk [Tests] Increase QMK test coverage take 2 (#15269) 2021-11-23 13:31:01 +11:00
build_json.mk
build_keyboard.mk Move tmk_core/common/<plat> (#13918) 2021-11-19 10:41:02 -08:00
build_layout.mk
build_test.mk Re-add encoder tests (#15312) 2021-11-27 22:19:22 +11:00
common_features.mk Move tmk_core/common/<plat> (#13918) 2021-11-19 10:41:02 -08:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
nose2.cfg
paths.mk Move tmk_core/common/<plat> (#13918) 2021-11-19 10:41:02 -08:00
readme.md
requirements-dev.txt Macros in JSON keymaps (#14374) 2021-11-22 11:11:35 -08:00
requirements.txt
setup.cfg
shell.nix
testlist.mk [Bug] Revert Assymmetrical Split Encoder support (#12090) (#15311) 2021-11-27 14:40:09 +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.