Go to file
fauxpark 98fa82ceef Backlighting docs (#3526)
* Some words about backlighting

* Link to RGB feature pages
2018-07-30 23:22:52 -07:00
.vscode Xton's first keymap! (#2941) 2018-05-12 08:52:11 -07:00
docs Backlighting docs (#3526) 2018-07-30 23:22:52 -07:00
drivers DC01 keyboard addition (#3428) 2018-07-18 12:55:57 -04:00
keyboards Keymap: Added rbong keyboard layout (#3517) 2018-07-30 23:20:30 -07:00
layouts Keymap: Adjustments to my Ortho_4x12 layout configs (#3466) 2018-07-23 12:23:44 -07:00
lib gcc 8.10 compilation fix (#2914) 2018-05-09 23:39:46 -04:00
quantum Added alternating led underglow pattern (#3498) 2018-07-29 08:42:11 -07:00
tests
tmk_core Loop based vusb_transfer_keyboard 2018-07-22 11:49:36 -04:00
users Keymaps: correct error in mtdjr userspace for layer_state_set_user (#3521) 2018-07-29 21:45:09 -07:00
util Added gentoo to installer (#3272) 2018-07-15 14:14:47 -04:00
.clang_complete
.editorconfig Fix .editorconfig to not mess with line endings 2018-02-03 15:20:44 -05:00
.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 Correct parsing of rules.mk for keyboard revisions 2018-07-17 00:10:42 -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 Lets split eh (#3120) 2018-07-16 22:25:02 -04:00
common_features.mk Lets split eh (#3120) 2018-07-16 22:25:02 -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 Reset color after submodule warning message 2018-01-12 13:25:05 -05:00
readme.md add discord link 2018-05-03 15:56:10 -04:00
secrets.tar.enc
shell.nix allow building with nix on darwin 2018-07-15 13:58:50 -04: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, 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.