elpekenin QMK¶
Caution
This is not an usual QMK external userspace. I use a custom script to compile (elpekenin_userspace build
)
Motivation for this setup is to easily keep code out of tree, but in sync with QMK changes.
Introduction¶
This documentation is built using
Sphinx: Documentation framework
Furo: Theme for Sphinx styling
Hawkmoth: Plugin to work with C code in Sphinx
Of course, some writing in
.rst
files
Keep in mind that docs might be out of date with the actual code. However I’ve put quite some effort in generating it automatically from doc-comments in the code, in hopes to reduce this friction. If you find anything out-of-sync please let me know
File structure¶
docs: files used to generate this page
keyboards/elpekenin/access: contains source for my custom PCB, and my keymap inside it
modules/elpekenin: submodule pointing to my community modules
users/elpekenin: most of the code, structured as
src: source code
include: header files
mk: Makefile logic, broken into “small” sections
scripts: Python that generates code at compile time
painter: Quantum Painter assets
autocorrect: database of corrections
Then,
patches/
andbuild.json
will put everything together into a clone ofqmk_firmware
to build