62ef4a9c8a
* clean up keyboard header files * use #pragma once include guard * convert tabs to spaces * remove redundant #include statements * update revision references to main header (`../meira.h` -> `meira.h`) * refactor default keymap * use LAYOUT as layout macro reference * use enum statement for layer indexes; make layers contiguous * use four-space indent * update keycode grid alignment * update layout macro aliases * move layout macro aliases to info.json * alias KEYMAP to LAYOUT_ortho_4x12 so the user keymaps don't have to be edited * touch up meira.h There's no Planck MIT layout reference here. * add copyright headers * workaround patch for grahampheath keymap The `matrix_init_kb()` function in `meira.c` calls `backlight_set()`, but the grahampheath keymap disables Backlight to make space for Audio, causing the firmware to fail to compile. This commit wraps the `backlight_set()` call in an ifdef statement, so the call is excluded if Backlight is disabled. * clean up rules.mk inline comments * re-order rules.mk settings * clean up readme.md * correct link to keyboard image * change metadata section to unordered list * spelling corrections * update make instructions and Docs links |
||
---|---|---|
.github | ||
.vscode | ||
api_data | ||
bin | ||
data | ||
docs | ||
drivers | ||
keyboards | ||
layouts | ||
lib | ||
platforms | ||
quantum | ||
tests | ||
tmk_core | ||
users | ||
util | ||
.clang-format | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
.gitmodules | ||
Dockerfile | ||
Doxyfile | ||
LICENSE | ||
Makefile | ||
Vagrantfile | ||
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 | ||
disable_features.mk | ||
doxygen-todo | ||
license_GPLv2.md | ||
license_GPLv3.md | ||
license_Modified_BSD.md | ||
message.mk | ||
nose2.cfg | ||
readme.md | ||
requirements-dev.txt | ||
requirements.txt | ||
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 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 this page" 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.