skullY a380937f1f wip		4 years ago
.github	Update cli CI checkout to v2 (#8823)	4 years ago
.vscode	Allow trailing whitespace in markdown docs, for formatting purposes. (#8774)	4 years ago
bin	Move everything to Python 3.6 (#8835)	4 years ago
docs	[Docs] Japanese translation of docs/feature_encoders.md (#8843)	4 years ago
drivers	Fix AVR SPI parameter configuration, remove timeouts due to sync protocol. (#8775)	4 years ago
keyboards	Add VIA support to ID80 (#8791)	4 years ago
layouts	Add naked60 layout, clean up my userspace files and rules.mk. (#8848)	4 years ago
lib	wip	4 years ago
quantum	Merge pull request #8710 from vomindoraan/keymap_extras_fixup	4 years ago
tests	format code according to conventions [skip ci]	4 years ago
tmk_core	Clean up ATSAM ifdefs (#8808)	4 years ago
users	Add naked60 layout, clean up my userspace files and rules.mk. (#8848)	4 years ago
util	Remove Atmel FLIP from install scripts and documentation (#8822)	4 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	Remove old setup scripts (#8811)	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	wip	4 years ago
Vagrantfile	Configure Vagrant to use qmk_base_container (#6194)	4 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	Load keymap-level rules.mk when compiling keymap.json (#8841)	4 years ago
build_keyboard.mk	Align some ChibiOS build logic (#8461)	4 years ago
build_layout.mk	Add a mechanism for force building a particular community layout (#5027)	5 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	Add Word Per Minute calculation feature (#8054)	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-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	Fix up Arm builds with nix-shell. (#8312)	4 years ago
show_options.mk	Remove unused LED_BREATHING_TABLE	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.