Darren Meehan 9e99a9b98c Remove use of sudo in lily58 make docs (#10301 )		3 years ago
.github	Update file changes action (#10245)	3 years ago
.vscode	[Keyboard] add rhymestone by marksard (#9708)	3 years ago
bin	Move everything to Python 3.6 (#8835)	4 years ago
docs	[Docs] Update Japanese translation of feature_split_keyboard.md (#10283)	3 years ago
drivers	format code according to conventions [skip ci]	3 years ago
keyboards	Remove use of sudo in lily58 make docs (#10301)	3 years ago
layouts	[Keymap] major keymap overhaul (#10185)	3 years ago
lib	Update vusb to match 3rd endpoint. (#9020)	3 years ago
platforms/chibios	Remove unused CORTEX_VTOR_INIT (#10053)	3 years ago
quantum	quantum/debounce: rename debouncing algorithms (#9564)	3 years ago
tests	format code according to conventions [skip ci]	4 years ago
tmk_core	Use the force when flashing with dfu-programmer (#10070)	3 years ago
users	[Keymap] major keymap overhaul (#10185)	3 years ago
util	Initial work for consolidation of ChibiOS platform files (#8327)	3 years ago
.clang-format	fix indent size	4 years ago
.editorconfig	QMK CLI and JSON keymap support (#6176)	4 years ago
.gitattributes	Set eep files to binary mode	7 years ago
.gitignore	Allow for user song list (#9281)	3 years ago
.gitmodules	2020 May 30 Breaking Changes Update (#9215)	3 years ago
.travis.yml	Attempt to fix CI for non-master branches. (#9308)	3 years ago
CODE_OF_CONDUCT.md	updates the coc	4 years ago
Dockerfile	Update docker util script and travis to use new base container	4 years ago
Doxyfile	Generate API docs from source code comments (#2491)	6 years ago
LICENSE	add an explicit lisence file for github to pickup	6 years ago
Makefile	2020 May 30 Breaking Changes Update (#9215)	3 years ago
Vagrantfile	Remove broken example from Makefile (#9159)	3 years ago
book.json	adds redirects for docs	6 years ago
bootloader.mk	Kiibohd bootloader, take 2 (#10129)	3 years ago
build_full_test.mk	Add SRC and OPT_DEFS when building tests	6 years ago
build_json.mk	Load keymap-level rules.mk when compiling keymap.json (#8841)	4 years ago
build_keyboard.mk	Initial work for consolidation of ChibiOS platform files (#8327)	3 years ago
build_layout.mk	Allow for building layouts from keymap.json files.	3 years ago
build_test.mk	Initial arm->chibios pass - simplify some platform logic (#8450)	4 years ago
common.mk	Move Split Common VPATH addition (#4716)	5 years ago
common_features.mk	quantum/debounce: rename debouncing algorithms (#9564)	3 years ago
doxygen-todo	Remove iWRAP protocol (#9284)	3 years ago
license_GPLv2.md	Clarify the quantum license (#1042)	7 years ago
license_GPLv3.md	Clarify the quantum license (#1042)	7 years ago
license_Modified_BSD.md	Clarify the quantum license (#1042)	7 years ago
message.mk	2020 May 30 Breaking Changes Update (#9215)	3 years ago
nose2.cfg	Setup a python test framework	4 years ago
readme.md	Revert "Branch point for 2020 Aug 29 Breaking Change"	3 years ago
requirements-dev.txt	Use milc for config check, requirements fixes	4 years ago
requirements.txt	CLI: Add development mode support	4 years ago
secrets.tar.enc	update building for .hex, secrets moving	6 years ago
setup.cfg	Add flake8 to our test suite and fix all errors (#7379)	4 years ago
shell.nix	shell.nix improvements, and fix problems on Darwin (#9551)	3 years ago
show_options.mk	Better handle LTO_ENABLE (#9832)	3 years ago
testlist.mk	Add basic infrastrucure for building full tests	6 years ago

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.