summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMamoor Jaan Khan <56243233+LowNightSnack@users.noreply.github.com>2020-09-11 20:42:33 +0530
committerGitHub <noreply@github.com>2020-09-11 20:42:33 +0530
commit54437db0ba2809de5ef0b987f59cfe47c486c669 (patch)
tree787ec61e3b54ec2e0a59bb1f984cc2c891bed825
parent98bd4796cfa3888e0f91d295599e42524e8e07db (diff)
Update with the examples
-rw-r--r--docs/docs/dev-guide-new-shield.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/docs/dev-guide-new-shield.md b/docs/docs/dev-guide-new-shield.md
index 832519d..6140b07 100644
--- a/docs/docs/dev-guide-new-shield.md
+++ b/docs/docs/dev-guide-new-shield.md
@@ -66,6 +66,8 @@ endif
![Labelled Pro Micro pins](assets/pro-micro/pro-micro-pins-labelled.jpg)
+ZMK uses the green color coded pin names to generate devicetree node references. For example, to refer to the node `D0` in the devicetree files, use `&pro_micro_d 0` or to refer to `A1`, use `&pro_micro_a 1`.
+
The `<shield_name>.overlay` is the devicetree description of the keyboard shield that is merged with the primary board devicetree description before the build. For ZMK, this file at a minimum should include the [chosen]() node named `zmk,kscan` that references a KSCAN driver instance. For a simple 3x3 macropad matrix,
this might look something like: