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.
 
 
 
 
 
skullY 471722f495 wip 5 years ago
.github Tweak issue templates (capitalisation mostly) (#5133) 5 years ago
.vscode Xton's first keymap! (#2941) 5 years ago
docs getting_started_build_tools: dfu-{util,programmer} now available from arch repo 5 years ago
drivers wip 5 years ago
keyboards wip 5 years ago
layouts [Keymap] Add KC_MAKE keycode to my userspace and keymaps (#5324) 5 years ago
lib Revert changes to chibiOS-contrib (#4176) 5 years ago
quantum increase size of note counter variable to avoid overflow 5 years ago
tests Remove empty action_function() 5 years ago
tmk_core Velocikey: Match RGB animation speed to typing speed (#3754) 5 years ago
users Update edvorak keymap simplify (#5350) 5 years ago
util Ask for your name when generating a new keyboard (#5214) 5 years ago
.clang-format Add .clang-format file 5 years ago
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) 6 years ago
.editorconfig Fix .editorconfig to not mess with line endings 6 years ago
.gitattributes Set eep files to binary mode 7 years ago
.gitignore Add Satisfaction75 to QMK, Enable EEPROM on stm32f072 (#5094) 5 years ago
.gitmodules Update .gitmodules 6 years ago
.travis.yml Remove AUTOGEN and fix Travis Compiled Push scripts (#5077) 5 years ago
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 5 years ago
Dockerfile Add a better Docker build script + update Dockerfile (#4222) 5 years ago
Doxyfile Generate API docs from source code comments (#2491) 6 years ago
LICENSE add an explicit lisence file for github to pickup 6 years ago
Makefile Shallow clone submodules. (#5279) 5 years ago
Vagrantfile Initial fixes for vagrant (#4900) 5 years ago
autocomplete.sh Make arguments redo, subproject elimination (#1784) 6 years ago
book.json adds redirects for docs 6 years ago
bootloader.mk Add Teensy ++ 2.0 bootloader support 5 years ago
build_full_test.mk Add SRC and OPT_DEFS when building tests 6 years ago
build_keyboard.mk Add a mechanism for force building a particular community layout (#5027) 5 years ago
build_layout.mk Add a mechanism for force building a particular community layout (#5027) 5 years ago
build_test.mk Split common.mk into common.mk and common_features.mk 6 years ago
common.mk Move Split Common VPATH addition (#4716) 5 years ago
common_features.mk Clean up debounce a bit (#5255) 5 years ago
doxygen-todo Generate API docs from source code comments (#2491) 6 years ago
license_GPLv2.md Clarify the quantum license (#1042) 7 years ago
license_GPLv3.md Clarify the quantum license (#1042) 7 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 7 years ago
message.mk Treat too-large firmwares as an error, not a warning (#3956) 5 years ago
readme.md Add Atreus as an official board. 5 years ago
secrets.tar.enc update building for .hex, secrets moving 6 years ago
shell.nix shell.nix: Packages relocated in upstream cleanup 5 years ago
show_options.mk Clean up debounce a bit (#5255) 5 years ago
testlist.mk Add basic infrastrucure for building full tests 6 years ago

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.