da6d6ce2e1
* docs: clarify in "Keymap Overview" what LAYOUT is and isn't
It is not strictly necessary to use LAYOUT macros in keyboard.c, but it
is a convenient abstraction of hardware internals, allowing focus on the
physical keyboard layout.
From the C source point of view LAYOUT is macro with a parameter list,
which expands to a array of rows that each is an array with a keyboard
scancode for each column. A macro parameter list is not an array, and
even less a single array.
Perhaps no big deal, but also no reason to give incorrect hints.
* docs: update "Understanding QMK's Code" to current code structure introduced in
|
4 years ago | |
|---|---|---|
| .github | 4 years ago | |
| .vscode | 4 years ago | |
| api_data | ||
| builddefs | 4 years ago | |
| data | 4 years ago | |
| docs | 4 years ago | |
| drivers | 4 years ago | |
| keyboards | 4 years ago | |
| layouts | 4 years ago | |
| lib | 4 years ago | |
| platforms | 4 years ago | |
| quantum | 4 years ago | |
| tests | 4 years ago | |
| tmk_core | 4 years ago | |
| users | 4 years ago | |
| util | 4 years ago | |
| .clang-format | 4 years ago | |
| .editorconfig | ||
| .gitattributes | 4 years ago | |
| .gitignore | 4 years ago | |
| .gitmodules | 4 years ago | |
| Dockerfile | 4 years ago | |
| Doxyfile | 4 years ago | |
| LICENSE | ||
| Makefile | 4 years ago | |
| Vagrantfile | 4 years ago | |
| doxygen-todo | 4 years ago | |
| license_GPLv2.md | ||
| license_GPLv3.md | ||
| license_Modified_BSD.md | ||
| nose2.cfg | ||
| paths.mk | 4 years ago | |
| readme.md | ||
| requirements-dev.txt | 4 years ago | |
| requirements.txt | ||
| setup.cfg | ||
| shell.nix | 4 years ago | |
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.