Go to file
Fred Silberberg 48913153c3 Replace gitter links with Discord. (#3368) 2018-07-11 00:01:56 -07:00
.vscode Xton's first keymap! (#2941) 2018-05-12 08:52:11 -07:00
docs Replace gitter links with Discord. (#3368) 2018-07-11 00:01:56 -07:00
drivers remove comment code 2018-06-23 14:34:41 -04:00
keyboards add hhkb bluetooth functionality (rn42) (#2693) 2018-07-09 18:12:59 -07:00
layouts Add up/down keys to the code layer for ease of intellisense usage. (#3363) 2018-07-09 18:06:50 -07:00
lib gcc 8.10 compilation fix (#2914) 2018-05-09 23:39:46 -04:00
quantum Merge pull request #3229 from qmk/hf/shinydox 2018-07-03 14:06:36 -04:00
tests
tmk_core Diagonal micro move fix 2018-06-28 22:10:53 -04:00
users Correct conditional in mtdjr userspace (#3361) 2018-07-09 12:50:04 -07:00
util Instruct macos users to use avr-gcc@7 (#3337) 2018-07-07 17:37:37 -07:00
.clang_complete
.editorconfig
.gitattributes
.gitignore Ajp10304 (#2719) 2018-04-15 09:48:19 -07:00
.gitmodules
.travis.yml Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
LICENSE
Makefile Added a clean target to remove build artifacts 2018-03-16 16:44:22 -04: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 Add Teensy ++ 2.0 bootloader support 2018-05-08 20:08:17 -04:00
build_full_test.mk
build_keyboard.mk Import userspace config.h according to USER_NAME (#2983) 2018-05-22 12:47:28 -07:00
build_layout.mk
build_test.mk
common.mk
common_features.mk Rgb matrix fixes, I2C library can now retry if it has failed (#2943) 2018-05-14 10:17:24 -04:00
doxygen-todo Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk
readme.md add discord link 2018-05-03 15:56:10 -04:00
secrets.tar.enc
shell.nix
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, and the Clueboard by Zach White.

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.