⌨️ Open-source keyboard firmware for Atmel AVR and Arm USB families
Find a file
Takuya Urakawa e2dee054d0 add st-link_cli flashing (#3899)
* add st-link_cli support

* format names
2018-09-28 21:30:44 -04:00
.vscode Xton's first keymap! (#2941) 2018-05-12 08:52:11 -07:00
docs Spell-check update for Userspace documentation 2018-09-28 14:39:52 -04:00
drivers RAMA U80-A, wilba.tech WT60-A, WT65-A, WT80-A, IS31FL3736 driver (#3925) 2018-09-27 10:40:44 -04:00
keyboards Keymap: Clicky frequency modulation (#4012) 2018-09-28 12:44:15 -07:00
layouts Bugfix for 60_ansi_tsangan and 60_iso_tsangan layouts (#3987) 2018-09-26 19:19:38 -07:00
lib Fix mismatched aliased event and event stub function prototypes. 2018-09-11 12:52:57 -07:00
quantum Update quantum matrix to support both AVR and Chibios ARM (#3968) 2018-09-28 12:33:11 -04:00
tests add tests for action_layer.c and reset layer state after tests 2017-12-15 13:23:30 -05:00
tmk_core add st-link_cli flashing (#3899) 2018-09-28 21:30:44 -04:00
users Keymap: mtdjr userspace changes and Nyquist keymap addition (#3940) 2018-09-26 12:23:30 -07:00
util Pin avr-gcc in shell.nix pending release of 8.3.0 (#3922) 2018-09-25 15:16:35 -07:00
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) 2017-12-11 21:06:05 -05:00
.editorconfig Fix .editorconfig to not mess with line endings 2018-02-03 15:20:44 -05:00
.gitattributes Set eep files to binary mode 2016-08-27 18:37:28 +03:00
.gitignore Ajp10304 (#2719) 2018-04-15 09:48:19 -07:00
.gitmodules Update .gitmodules 2017-11-16 15:09:45 -05:00
.travis.yml Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
autocomplete.sh Make arguments redo, subproject elimination (#1784) 2017-10-14 11:32:19 -10:00
book.json adds redirects for docs 2017-08-19 08:31:54 -04:00
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 Massdrop keyboard support (#3780) 2018-08-29 15:07:52 -04:00
build_layout.mk Creates a layouts/ folder for keymaps shared between keyboards (#1609) 2017-08-23 22:29:07 -04:00
build_test.mk Split common.mk into common.mk and common_features.mk 2017-06-18 21:22:22 +03:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2018-08-01 15:20:02 -04:00
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
Dockerfile Reverting CMD Changes 2017-08-19 08:17:58 -04:00
Doxyfile Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
doxygen-todo Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
LICENSE add an explicit lisence file for github to pickup 2017-11-13 20:50:54 -05:00
license_GPLv2.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_GPLv3.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_Modified_BSD.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
Makefile improve looks like hang up when first time execute make git-submodule (#3846) 2018-09-10 16:21:54 -07:00
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 update building for .hex, secrets moving 2017-08-21 21:57:46 -04:00
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
Vagrantfile removed unused boxes (qmk won't compile with them anyway), updated welcome message 2018-06-28 22:09:38 -04:00

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.