You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Go to file
fauxpark 3ad389de55 Add short aliases for Magic keycodes (#7541)
* Add short alias for `MAGIC_TOGGLE_NKRO`

* Add aliases for the other Bootmagic keycodes

* Replace long form in default keymaps
5 years ago
.github Fix typos in stale.yml (#7489) 5 years ago
.vscode Generalize Tap Dance Layer functions (#6629) 6 years ago
bin Add pep8-naming to our python linting 5 years ago
docs Add short aliases for Magic keycodes (#7541) 5 years ago
drivers Increase matrix scanning speed on xd84 (#7517) 5 years ago
keyboards Add short aliases for Magic keycodes (#7541) 5 years ago
layouts [Keyboard] Add three missing layouts (#7441) 6 years ago
lib Add pep8-naming to our python linting 5 years ago
quantum Add short aliases for Magic keycodes (#7541) 5 years ago
tests clang-format changes 6 years ago
tmk_core Remove vusb 'reset to bootloader' hid message due to security implications (#7456) 6 years ago
users [Keymap] Add RGB keycodes to keymap, enable RGB_MATRIX on crkbd (#7499) 5 years ago
util Fix install for Linux Ubuntu (#7520) 5 years ago
.clang-format fix indent size 6 years ago
.clang_complete
.editorconfig QMK CLI and JSON keymap support (#6176) 6 years ago
.gitattributes
.gitignore [Docs] Update hand wire guide (#7044) 6 years ago
.gitmodules add lufa as a submodule 6 years ago
.travis.yml CI - Fix change detection (#7038) 6 years ago
CODE_OF_CONDUCT.md updates the coc 6 years ago
Dockerfile Update docker util script and travis to use new base container 6 years ago
Doxyfile
LICENSE
Makefile Allow 'make all:<user>' to not build EVERYTHING (#7402) 6 years ago
Vagrantfile Configure Vagrant to use qmk_base_container (#6194) 6 years ago
autocomplete.sh
book.json
bootloader.mk Update bootloader.mk (#6698) 6 years ago
build_full_test.mk
build_json.mk Make generating keymap.c from JSON more reliable 6 years ago
build_keyboard.mk add 'objs-size' target into tmk_core/avr.mk (#5490) 6 years ago
build_layout.mk Add a mechanism for force building a particular community layout (#5027) 6 years ago
build_test.mk
common.mk
common_features.mk Relocate magic keycode processing (#7512) 5 years ago
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Add list-keymaps make target (#5563) 6 years ago
nose2.cfg Setup a python test framework 6 years ago
readme.md Set up language fallback for docs, and update translation guidelines (#7403) 6 years ago
requirements.txt Add pep8-naming to our python linting 5 years ago
secrets.tar.enc
setup.cfg Add flake8 to our test suite and fix all errors (#7379) 6 years ago
shell.nix Fix shell.nix by pinning nixpkgs (#6213) 6 years ago
show_options.mk Add Dip Switch as a core feature (#6140) 6 years ago
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 powered by Docsify and hosted on GitHub. They are also viewable offline; see Previewing the Documentation for more details.

You can request changes by making a fork and opening a pull request, or by clicking the "Edit Document" link at the bottom of any page.

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 ZSA Technology Labs, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

Official Website

qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.