Go to file
Erovia 21799be1ca Make dedicated sections for user/dev commands in docs 2020-04-08 09:31:14 -07:00
.github Force "blank" issue template to end of list (#8387) 2020-03-12 01:27:33 -07:00
.vscode Highlight .inc files as .c files (#8496) 2020-03-20 09:48:55 +01:00
bin Rebase on master, hide some other subcommands 2020-04-08 09:31:14 -07:00
docs Make dedicated sections for user/dev commands in docs 2020-04-08 09:31:14 -07:00
drivers format code according to conventions [skip ci] 2020-04-08 01:38:16 +00:00
keyboards Update info.json (#8723) 2020-04-08 15:09:20 +02:00
layouts jotix layouts (#8644) 2020-04-05 23:15:24 +01:00
lib Rebase on master, hide some other subcommands 2020-04-08 09:31:14 -07:00
quantum Configurable VIA layout options default value (#8707) 2020-04-06 20:27:44 +01:00
tests format code according to conventions [skip ci] 2020-03-13 18:44:56 +00:00
tmk_core spi_master for AVR (#8299) 2020-04-08 11:04:31 +10:00
users DennyTom's buttery_engine (#8138) 2020-04-07 21:13:17 +10:00
util Miscellaneous cleanups (#8639) 2020-04-01 15:49:45 +01:00
.clang-format
.clang_complete
.editorconfig
.gitattributes
.gitignore 2020 February 29 Breaking Changes Update (#8064) 2020-02-29 11:59:30 -08:00
.gitmodules Track master branches for lib/chibios, lib/chibios-contrib, lib/ugfx. (#8273) 2020-03-01 11:51:38 +11:00
.travis.yml Fix unknown key 'IndentPPDirectives' on CI (#7933) 2020-01-19 13:59:57 -08:00
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile 2020 February 29 Breaking Changes Update (#8064) 2020-02-29 11:59:30 -08:00
Vagrantfile
autocomplete.sh
book.json
bootloader.mk Add LUFA mass storage `BOOTLOADER` "support" (#7729) 2019-12-29 20:53:23 +00:00
build_full_test.mk
build_json.mk Rename qmk json-keymap to qmk json2c (#8372) 2020-03-10 13:51:19 -07:00
build_keyboard.mk Align some ChibiOS build logic (#8461) 2020-03-22 20:48:17 +11:00
build_layout.mk
build_test.mk Initial arm->chibios pass - simplify some platform logic (#8450) 2020-03-21 16:20:04 +11:00
common.mk
common_features.mk Add Word Per Minute calculation feature (#8054) 2020-03-23 00:06:16 +11:00
doxygen-todo Remove PJRC USB stack 2020-02-08 11:07:43 -08:00
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Use FIRMWARE_FORMAT for "Checking file size" message (#8121) 2020-02-10 04:19:08 +11:00
nose2.cfg
readme.md Breaking Changes documentation fixes 2020-02-29 12:30:38 -08:00
requirements-dev.txt Use milc for config check, requirements fixes 2020-04-08 09:31:14 -07:00
requirements.txt CLI: Add development mode support 2020-04-08 09:31:14 -07:00
secrets.tar.enc
setup.cfg Add flake8 to our test suite and fix all errors (#7379) 2019-11-20 14:54:18 -08:00
shell.nix Fix up Arm builds with nix-shell. (#8312) 2020-03-07 03:05:51 +11:00
show_options.mk Remove unused LED_BREATHING_TABLE 2020-03-06 22:29:01 -08:00
testlist.mk

readme.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

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

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.