From 4eb0fda5281a31cf12658ce83e7345e0f57bf4b7 Mon Sep 17 00:00:00 2001 From: phiwan-dev <75113544+phiwan-dev@users.noreply.github.com> Date: Fri, 5 Dec 2025 17:53:01 +0100 Subject: [PATCH] docs: readme add zmk section --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 6148e21..b971b3f 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,17 @@ cd /firmware - it should now auto-eject and run the new firmware +## Fighting with ZMK +- spend a lot of time on local toolchain and scripts +- other projects may have their config files in different places +- explain most important files which the user might want to change (and where) +- confusing, overwhelming (at first) +- flash reset firmware to fix problems +- dtsi is "weird" because of the way the matrix is connected (only on prototype) +- right overlay columns are reversed because its mirrored but pcb is non-mirrored +- main half controls layers of secondary half -> perhaps need to flash both sides for keymap to take new changes +- displays have close to 0 documentation at all + # Thanks - to https://github.com/MvEerd/ergogen/tree/mveerd for ergogen