Go to file

Ryan b16091659c Move USB Host Shield and Arduino core to `lib/` (#13973 )		2021-08-18 18:20:25 +10:00
.github	…
.vscode	…
api_data	…
bin	…
data	Add a lot more data to info.json (#13366 )	2021-08-16 23:33:30 +01:00
docs	Allow for removal of hysteresis on 4x encoders (#13698 )	2021-08-18 09:40:00 +10:00
drivers	Relocate platform specific drivers (#13894 )	2021-08-17 23:43:09 +01:00
keyboards	Merge remote-tracking branch 'origin/master' into develop	2021-08-17 22:33:17 -07:00
layouts	…
lib	Move USB Host Shield and Arduino core to `lib/` (#13973 )	2021-08-18 18:20:25 +10:00
nix	…
platforms	Move chibios board files to allow tmk_core platform migration (#13777 )	2021-08-18 00:04:15 +01:00
quantum	Allow for removal of hysteresis on 4x encoders (#13698 )	2021-08-18 09:40:00 +10:00
tests	…
tmk_core	Move USB Host Shield and Arduino core to `lib/` (#13973 )	2021-08-18 18:20:25 +10:00
users	…
util	[CLI] Add qmk-hid bootloader detection support to `qmk console` (#14038 )	2021-08-18 04:13:54 +10:00
.clang-format	…
.editorconfig	…
.gitattributes	…
.gitignore	…
.gitmodules	…
.travis.yml	…
CODE_OF_CONDUCT.md	…
Dockerfile	…
Doxyfile	…
LICENSE	…
Makefile	…
Vagrantfile	…
book.json	…
bootloader.mk	…
build_full_test.mk	…
build_json.mk	…
build_keyboard.mk	Begin to carve out platform/protocol API - Single main loop (#13843 )	2021-08-18 00:11:07 +01:00
build_layout.mk	…
build_test.mk	…
common.mk	Relocate platform specific drivers (#13894 )	2021-08-17 23:43:09 +01:00
common_features.mk	Various fixes from reorg of files (#14051 )	2021-08-18 09:54:41 +10:00
disable_features.mk	…
doxygen-todo	Various fixes from reorg of files (#14051 )	2021-08-18 09:54:41 +10:00
license_GPLv2.md	…
license_GPLv3.md	…
license_Modified_BSD.md	…
message.mk	`--parallel` improvements (#13800 )	2021-08-18 08:46:59 +10:00
nose2.cfg	…
readme.md	…
requirements-dev.txt	…
requirements.txt	…
secrets.tar.enc	…
setup.cfg	…
shell.nix	…
show_options.mk	…
testlist.mk	…

readme.md

Quantum Mechanical Keyboard Firmware

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

See the official documentation on docs.qmk.fm

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.