Go to file

Pete Johanson b9a38487f3 [Docs] Update udev rules to use TAG+="uaccess". (#8750 )		2020-06-07 09:06:55 +01:00
.github	…
.vscode	…
bin	…
docs	[Docs] Update udev rules to use TAG+="uaccess". (#8750 )	2020-06-07 09:06:55 +01:00
drivers	ISSI driver compile error fix (#9169 )	2020-05-27 01:18:13 +01:00
keyboards	[Keyboard] Add Via config for Clueboard 66 (#9010 )	2020-06-06 08:56:59 -07:00
layouts	Major enhancements to spidey3 keymaps and userspace (#9261 )	2020-06-05 02:01:47 -07:00
lib	2020 May 30 Breaking Changes Update (#9215 )	2020-05-30 13:14:59 -07:00
quantum	Move encoder_read to common location (#9003 )	2020-06-03 00:54:53 +01:00
tests	…
tmk_core	Move encoder_read to common location (#9003 )	2020-06-03 00:54:53 +01:00
users	Major enhancements to spidey3 keymaps and userspace (#9261 )	2020-06-05 02:01:47 -07:00
util	Void Linux: Switch to cross-arm-none-eabi toolchain (#9228 )	2020-06-02 18:53:38 +10:00
.clang-format	…
.editorconfig	…
.gitattributes	…
.gitignore	…
.gitmodules	2020 May 30 Breaking Changes Update (#9215 )	2020-05-30 13:14:59 -07:00
.travis.yml	…
CODE_OF_CONDUCT.md	…
Dockerfile	…
Doxyfile	…
LICENSE	…
Makefile	2020 May 30 Breaking Changes Update (#9215 )	2020-05-30 13:14:59 -07:00
Vagrantfile	Remove broken example from Makefile (#9159 )	2020-05-21 20:33:20 +01:00
book.json	…
bootloader.mk	…
build_full_test.mk	…
build_json.mk	…
build_keyboard.mk	…
build_layout.mk	…
build_test.mk	…
common.mk	…
common_features.mk	Add SPI 25xx EEPROM support. (#8780 )	2020-05-19 10:34:00 +10:00
doxygen-todo	…
license_GPLv2.md	…
license_GPLv3.md	…
license_Modified_BSD.md	…
message.mk	2020 May 30 Breaking Changes Update (#9215 )	2020-05-30 13:14:59 -07:00
nose2.cfg	…
readme.md	…
requirements-dev.txt	…
requirements.txt	…
secrets.tar.enc	update building for .hex, secrets moving	2017-08-21 21:57:46 -04:00
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.