367eac2229
* Move default keymap's rules to keyboard level * Concatenate the two sets of rules This sets CONSOLE_ENABLE to no, which was being set at the keymap level. * Wrap the USB Device Description in quotes Some preventative maintenance. The firmware for the_ruler can't be compiled without this change if `CONSOLE_ENABLE = yes` because this string has a comma, which gets picked up as two arguments by the Command code, instead of one as it should be. * Linting - remove firmware size impacts - remove trailing white space - visual alignment of rules * Use QMK's pre-loaded default rules for atmega32u4 * Update readme - markdown formatting - update Hardware Availability link (Maple Computing's site has disappeared) - update Docs links * Update header files to use #pragma once |
||
---|---|---|
.github | ||
.vscode | ||
bin | ||
docs | ||
drivers | ||
keyboards | ||
layouts | ||
lib | ||
quantum | ||
tests | ||
tmk_core | ||
users | ||
util | ||
.clang-format | ||
.clang_complete | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
.gitmodules | ||
.travis.yml | ||
CODE_OF_CONDUCT.md | ||
Dockerfile | ||
Doxyfile | ||
LICENSE | ||
Makefile | ||
Vagrantfile | ||
autocomplete.sh | ||
book.json | ||
bootloader.mk | ||
build_full_test.mk | ||
build_json.mk | ||
build_keyboard.mk | ||
build_layout.mk | ||
build_test.mk | ||
common.mk | ||
common_features.mk | ||
doxygen-todo | ||
license_GPLv2.md | ||
license_GPLv3.md | ||
license_Modified_BSD.md | ||
message.mk | ||
readme.md | ||
requirements.txt | ||
secrets.tar.enc | ||
setup.cfg | ||
shell.nix | ||
show_options.mk | ||
testlist.mk |
readme.md
Quantum Mechanical Keyboard Firmware
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 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.