Go to file
MechMerlin e0690096f8 Fix my community layouts (#4449)
* fix formatting of keymap

* update readme with boards I currently own

* made the wrong assumption that every board would use the same space for backspace

* update readme with boards I currently own
2018-11-18 15:20:21 -08:00
.vscode Xton's first keymap! (#2941) 2018-05-12 08:52:11 -07:00
docs Allows disabling rgb effects in userspace (#4422) 2018-11-18 08:24:41 -08:00
drivers I2C driver docs (#4298) 2018-11-10 15:26:39 -05:00
keyboards Satan: add LAYOUT_60_ansi_split_rshift to info.json (#4441) 2018-11-18 08:23:51 -08:00
layouts Fix my community layouts (#4449) 2018-11-18 15:20:21 -08:00
lib Revert changes to chibiOS-contrib (#4176) 2018-10-19 12:42:28 -07:00
quantum Allows disabling rgb effects in userspace (#4422) 2018-11-18 08:24:41 -08:00
tests
tmk_core Use a single endpoint for HID reports (#3951) 2018-11-15 22:22:05 -08:00
users Update to my keymaps and userspace (#4447) 2018-11-18 07:52:14 -08:00
util convert to unix line-endings [skip ci] 2018-11-12 20:51:24 +00: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 Update CODE_OF_CONDUCT.md 2018-08-01 15:20:02 -04:00
Dockerfile
Doxyfile Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
LICENSE
Makefile improve looks like hang up when first time execute make git-submodule (#3846) 2018-09-10 16:21:54 -07:00
Vagrantfile Update the installation script PR (#4167) 2018-10-22 13:24:43 -07: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 Add SRC and OPT_DEFS when building tests 2017-07-20 10:17:31 -04:00
build_keyboard.mk Fix LAYOUT define generation (#4148) 2018-10-16 14:14:52 -04:00
build_layout.mk
build_test.mk Split common.mk into common.mk and common_features.mk 2017-06-18 21:22:22 +03:00
common.mk Lets split eh (#3120) 2018-07-16 22:25:02 -04:00
common_features.mk Fix Terminal feature on ChibiOS 2018-11-06 00:40:02 -05: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 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 Add basic infrastrucure for building full tests 2017-06-18 21:08:23 +03:00

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.