Go to file
fauxpark 4335b97a07 Reorder Raw HID interface to match what the USB spec expects (#6801) 2019-10-08 11:47:37 -07:00
.github
.vscode Generalize Tap Dance Layer functions (#6629) 2019-09-21 11:22:27 -07:00
bin Configuration system for CLI (#6708) 2019-09-22 13:25:33 -07:00
docs [Docs] CLI command to serve docs locally (#6956) 2019-10-08 11:06:26 -07:00
drivers [Keyboard] RGB updates on NK65 and HS60 (#6795) 2019-10-08 09:03:51 -07:00
keyboards [Keymap] Adding my keymaps for Preonic and XD75 (#6874) 2019-10-08 11:26:17 -07:00
layouts [Keymap] Community layout for hhkb (#6961) 2019-10-07 13:31:11 -07:00
lib [Docs] CLI command to serve docs locally (#6956) 2019-10-08 11:06:26 -07:00
quantum ARM - Initial backlight support (#6487) 2019-10-05 16:57:00 +01:00
tests clang-format changes 2019-08-30 15:01:52 -07:00
tmk_core Reorder Raw HID interface to match what the USB spec expects (#6801) 2019-10-08 11:47:37 -07:00
users [Keymap] Overly greedy community keymap build userspace (#6969) 2019-10-07 19:23:59 -07:00
util Port drivers.txt changes from the Toolbox (#6786) 2019-09-30 17:45:44 -07:00
.clang-format
.clang_complete
.editorconfig QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
.gitattributes
.gitignore Correct casing for DS_Store in .gitignore (#6787) 2019-09-22 21:32:52 +10:00
.gitmodules add lufa as a submodule 2019-08-30 15:01:52 -07:00
.travis.yml removed deprecated option for Travis (#6896) 2019-10-05 12:04:46 -07:00
CODE_OF_CONDUCT.md updates the coc 2019-08-24 12:43:39 -04:00
Dockerfile
Doxyfile
LICENSE
Makefile Add list-keymaps make target (#5563) 2019-09-21 00:00:58 -07:00
Vagrantfile Configure Vagrant to use qmk_base_container (#6194) 2019-07-16 01:20:34 -07:00
autocomplete.sh
book.json
bootloader.mk Update bootloader.mk (#6698) 2019-09-18 09:48:58 +10:00
build_full_test.mk
build_json.mk Configuration system for CLI (#6708) 2019-09-22 13:25:33 -07:00
build_keyboard.mk add 'objs-size' target into tmk_core/avr.mk (#5490) 2019-07-15 22:45:31 -07:00
build_layout.mk
build_test.mk
common.mk
common_features.mk ARM - Initial backlight support (#6487) 2019-10-05 16:57:00 +01:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Add list-keymaps make target (#5563) 2019-09-21 00:00:58 -07:00
nose2.cfg Setup a python test framework 2019-09-07 07:58:41 -07:00
readme.md Merge point for 2019 Aug 30 Breaking Change 2019-08-30 15:01:52 -07:00
requirements.txt Configuration system for CLI (#6708) 2019-09-22 13:25:33 -07:00
secrets.tar.enc
setup.cfg QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
shell.nix add python3 to shell.nix (#6774) 2019-09-21 11:59:18 -07:00
show_options.mk Add Dip Switch as a core feature (#6140) 2019-09-03 08:34:31 -07: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 hosted on Gitbook and GitHub (they are synced). You can request changes by making a fork and pull request, or by clicking the "suggest an edit" link on any page of the docs.

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.