kofal.net/zmk
1
0
Fork 1
mirror of https://github.com/zmkfirmware/zmk.git synced 2026-03-20 04:55:20 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update dev-guide-new-shield.md

Browse Source
This commit is contained in:
Mamoor Jaan Khan
2020-09-10 09:59:33 +05:30
committed by GitHub
parent 6a0e85ea72
commit 82ddf81fcb
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/dev-guide-new-shield.md
View File

@@ -64,6 +64,8 @@ endif
## Shield Overlay ## Shield Overlay
![Labelled Pro Micro Image](pro-micro-labelled-image.jpg)
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, 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: this might look something like: