Go to file
Dylan Khor fbc6bd8266 Minor updates to build tools docs revised (#4195)
* add initial khord iris keymap

* correct path of windows qmk install script
2018-10-22 11:29:04 -07:00
.vscode
docs Minor updates to build tools docs revised (#4195) 2018-10-22 11:29:04 -07:00
drivers DC01 updates and I2C avr speed overwrite (#4088) 2018-10-08 18:27:04 -04:00
keyboards Updates docs - planck 6 and macos instructions (#4201) 2018-10-22 11:19:51 -07:00
layouts Keymap: qwerty_code_friendly: update readme, comments (#4178) 2018-10-19 16:47:59 -07:00
lib Revert changes to chibiOS-contrib (#4176) 2018-10-19 12:42:28 -07:00
quantum Fix Unicode EEPROM handling so it is consistent. (#4066) 2018-10-19 00:35:15 -04:00
tests
tmk_core Keyboard: bminiex : Working backlight (#4171) 2018-10-21 09:20:24 -07:00
users Big Switch and 5x5 edits (#4168) 2018-10-19 11:01:40 -07:00
util Enable support for Linux Mint 18 with linux_install.sh (#4042) 2018-10-02 22:16:49 -07:00
.clang_complete
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2018-08-01 15:20:02 -04:00
Dockerfile
Doxyfile
LICENSE
Makefile improve looks like hang up when first time execute make git-submodule (#3846) 2018-09-10 16:21:54 -07:00
Vagrantfile removed unused boxes (qmk won't compile with them anyway), updated welcome message 2018-06-28 22:09:38 -04:00
autocomplete.sh
book.json
bootloader.mk
build_full_test.mk
build_keyboard.mk Fix LAYOUT define generation (#4148) 2018-10-16 14:14:52 -04:00
build_layout.mk
build_test.mk
common.mk Lets split eh (#3120) 2018-07-16 22:25:02 -04:00
common_features.mk Fix RGB Matrix feature processing in common_features.mk 2018-09-28 17:11:05 -04:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Treat too-large firmwares as an error, not a warning (#3956) 2018-09-27 13:32:01 -07:00
readme.md Add Atreus as an official board. 2018-08-16 12:01:34 -04:00
secrets.tar.enc
shell.nix Pin avr-gcc in shell.nix pending release of 8.3.0 (#3922) 2018-09-25 15:16:35 -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 Erez Zukerman, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

Official website

http://qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.