skullY 8b4d28f6fb Fix omnikeyish		4 years ago
.github	CI: Add workflow for CLI testing (#7357)	4 years ago
.vscode	2020 February 29 Breaking Changes Update (#8064)	4 years ago
bin	Add pep8-naming to our python linting	4 years ago
docs	Fix the Breaking Changes doc again	4 years ago
drivers	PWM DMA based RGB Underglow for STM32 (#7928)	4 years ago
keyboards	Fix omnikeyish	4 years ago
layouts	2020 February 29 Breaking Changes Update (#8064)	4 years ago
lib	2020 February 29 Breaking Changes Update (#8064)	4 years ago
quantum	update the template too	4 years ago
tests	clang-format changes	4 years ago
tmk_core	Ensure more _user functions will always run	4 years ago
users	[Keymap] ninjonas keymap updates (#8170)	4 years ago
util	Allow for ChibiOS 20.x (master), as well as enabling ChibiOS-Contrib HAL. (#8272)	4 years ago
.clang-format	fix indent size	4 years ago
.clang_complete	Vim Layout for Ergodox-EZ (mac only) (#2112)	6 years ago
.editorconfig	QMK CLI and JSON keymap support (#6176)	4 years ago
.gitattributes	Set eep files to binary mode	7 years ago
.gitignore	2020 February 29 Breaking Changes Update (#8064)	4 years ago
.gitmodules	Track master branches for lib/chibios, lib/chibios-contrib, lib/ugfx. (#8273)	4 years ago
.travis.yml	Fix unknown key 'IndentPPDirectives' on CI (#7933)	4 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 February 29 Breaking Changes Update (#8064)	4 years ago
Vagrantfile	Configure Vagrant to use qmk_base_container (#6194)	4 years ago
autocomplete.sh	Make arguments redo, subproject elimination (#1784)	6 years ago
book.json	adds redirects for docs	6 years ago
bootloader.mk	Add LUFA mass storage `BOOTLOADER` "support" (#7729)	4 years ago
build_full_test.mk	Add SRC and OPT_DEFS when building tests	6 years ago
build_json.mk	Add JSON keymap to prereq list of C keymap	4 years ago
build_keyboard.mk	add 'objs-size' target into tmk_core/avr.mk (#5490)	4 years ago
build_layout.mk	Add a mechanism for force building a particular community layout (#5027)	5 years ago
build_test.mk	Split common.mk into common.mk and common_features.mk	6 years ago
common.mk	Move Split Common VPATH addition (#4716)	5 years ago
common_features.mk	2020 February 29 Breaking Changes Update (#8064)	4 years ago
doxygen-todo	Remove PJRC USB stack	4 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	Use FIRMWARE_FORMAT for "Checking file size" message (#8121)	4 years ago
nose2.cfg	Setup a python test framework	4 years ago
readme.md	Breaking Changes documentation fixes	4 years ago
requirements.txt	Drop bs4 dependency, update docs, minor improvements	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	Fix shell.nix by pinning nixpkgs (#6213)	4 years ago
show_options.mk	Fix AVR boards which were overriding backlight without setting… (#8044)	4 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.