You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

Jan-Frederick Musiol 49abff9071 changed type of process_combo_event argument in tutorial (#10621 ) in tutorial for combos feature, changed type of compo_index argument of process_combo_event form uint8_t to uint16_t		5 years ago
.github	Update file changes action (#10245 )	5 years ago
.vscode	[Keyboard] add rhymestone by marksard (#9708 )	5 years ago
bin	Move everything to Python 3.6 (#8835 )	6 years ago
docs	changed type of process_combo_event argument in tutorial (#10621 )	5 years ago
drivers	OLED driver fixes (#10377 )	5 years ago
keyboards	Fix configurator layout helix/rev3_4rows (#10618 )	5 years ago
layouts	[Keymap] Move my custom functions and keymaps to userspace (#10502 )	5 years ago
lib	CLI: Fix stripping of `ANY` from Configurator exports (#10585 )	5 years ago
platforms/chibios	Remove unused CORTEX_VTOR_INIT (#10053 )	5 years ago
quantum	Fix issue introduced by PR#10404 (#10559 )	5 years ago
tests	…
tmk_core	Add description in Bluetooth docs for requiring NKRO to be disabled (#10359 )	5 years ago
users	[Keymap] Move my custom functions and keymaps to userspace (#10502 )	5 years ago
util	MSYS2: Switch to arm-none-eabi-gcc package (#10421 )	5 years ago
.clang-format	…
.editorconfig	…
.gitattributes	…
.gitignore	Allow for user song list (#9281 )	5 years ago
.gitmodules	2020 May 30 Breaking Changes Update (#9215 )	6 years ago
.travis.yml	Attempt to fix CI for non-master branches. (#9308 )	5 years ago
CODE_OF_CONDUCT.md	…
Dockerfile	…
Doxyfile	…
LICENSE	…
Makefile	2020 May 30 Breaking Changes Update (#9215 )	6 years ago
Vagrantfile	Remove broken example from Makefile (#9159 )	6 years ago
book.json	…
bootloader.mk	Add logic for AT90USBxx7 where needed (#10203 )	5 years ago
build_full_test.mk	…
build_json.mk	Load keymap-level rules.mk when compiling keymap.json (#8841 )	6 years ago
build_keyboard.mk	Initial work for consolidation of ChibiOS platform files (#8327 )	5 years ago
build_layout.mk	Allow for building layouts from keymap.json files.	6 years ago
build_test.mk	Initial arm->chibios pass - simplify some platform logic (#8450 )	6 years ago
common.mk	…
common_features.mk	quantum/debounce: rename debouncing algorithms (#9564 )	5 years ago
doxygen-todo	Remove iWRAP protocol (#9284 )	5 years ago
license_GPLv2.md	…
license_GPLv3.md	…
license_Modified_BSD.md	…
message.mk	2020 May 30 Breaking Changes Update (#9215 )	6 years ago
nose2.cfg	…
readme.md	Revert "Branch point for 2020 Aug 29 Breaking Change"	5 years ago
requirements-dev.txt	Use milc for config check, requirements fixes	6 years ago
requirements.txt	[CLI] Add c2json (#8817 )	5 years ago
secrets.tar.enc	…
setup.cfg	…
shell.nix	shell.nix improvements, and fix problems on Darwin (#9551 )	5 years ago
show_options.mk	Better handle LTO_ENABLE (#9832 )	5 years ago
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.