Peter's keyboard firmware (QMK)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
fauxpark 03ad6927cb Docs: Format Space Cadet documentation (#3540) 1 year ago
.vscode Xton's first keymap! (#2941) 1 year ago
docs Docs: Format Space Cadet documentation (#3540) 1 year ago
drivers DC01 keyboard addition (#3428) 1 year ago
keyboards Keyboard: KBD75 Rev 1 LAYOUT_ansi_1u Bug (#3542) 1 year ago
layouts Keymap: Adjustments to my Ortho_4x12 layout configs (#3466) 1 year ago
lib gcc 8.10 compilation fix (#2914) 1 year ago
quantum Added alternating led underglow pattern (#3498) 1 year ago
tests add tests for action_layer.c and reset layer state after tests 2 years ago
tmk_core Loop based vusb_transfer_keyboard 1 year ago
users Keymaps: correct error in mtdjr userspace for layer_state_set_user (#3521) 1 year ago
util Added gentoo to installer (#3272) 1 year ago
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) 2 years ago
.editorconfig Fix .editorconfig to not mess with line endings 2 years ago
.gitattributes Set eep files to binary mode 3 years ago
.gitignore Ajp10304 (#2719) 1 year ago
.gitmodules Update .gitmodules 2 years ago
.travis.yml Generate API docs from source code comments (#2491) 1 year ago create initial code of conduct 2 years ago
Dockerfile Reverting CMD Changes 2 years ago
Doxyfile Generate API docs from source code comments (#2491) 1 year ago
LICENSE add an explicit lisence file for github to pickup 2 years ago
Makefile Correct parsing of for keyboard revisions 1 year ago
Vagrantfile removed unused boxes (qmk won't compile with them anyway), updated welcome message 1 year ago Make arguments redo, subproject elimination (#1784) 2 years ago
book.json adds redirects for docs 2 years ago Add Teensy ++ 2.0 bootloader support 1 year ago Add SRC and OPT_DEFS when building tests 2 years ago Import userspace config.h according to USER_NAME (#2983) 1 year ago Creates a layouts/ folder for keymaps shared between keyboards (#1609) 2 years ago Split into and 2 years ago Lets split eh (#3120) 1 year ago Lets split eh (#3120) 1 year ago
doxygen-todo Generate API docs from source code comments (#2491) 1 year ago Clarify the quantum license (#1042) 2 years ago Clarify the quantum license (#1042) 2 years ago Clarify the quantum license (#1042) 2 years ago Reset color after submodule warning message 2 years ago add discord link 1 year ago
secrets.tar.enc update building for .hex, secrets moving 2 years ago
shell.nix allow building with nix on darwin 1 year ago Add basic infrastrucure for building full tests 2 years ago

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.


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.


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 is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.