a1096e1dec
* Indicate <keyboard>.h LAYOUT() deprecation in understanding_qmk.md Initial documentation uses <keyboard>.json to define matrix pin definitions, rather than having users #define the LAYOUT() macro in <keyboard>.h - This change brings this docs inline with the [porting_guidelines](https://docs.qmk.fm/porting_your_keyboard_to_qmk), QMK MSYS will also throw an error if this is attempted. * Update understanding_qmk.md enclosed '<' using backtick * style guideline, now builds correctly prior version indicates directory, new indicates config. still the same idea. |
||
|---|---|---|
| .github | ||
| .vscode | ||
| builddefs | ||
| data | ||
| docs | ||
| drivers | ||
| keyboards | ||
| layouts | ||
| lib | ||
| modules/qmk | ||
| platforms | ||
| quantum | ||
| tests | ||
| tmk_core | ||
| users | ||
| util | ||
| .clang-format | ||
| .clangd | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| Doxyfile | ||
| doxygen-todo | ||
| LICENSE | ||
| license_GPLv2.md | ||
| license_GPLv3.md | ||
| license_Modified_BSD.md | ||
| Makefile | ||
| nose2.cfg | ||
| paths.mk | ||
| readme.md | ||
| requirements-dev.txt | ||
| requirements.txt | ||
| setup.cfg | ||
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 VitePress. 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.
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.