kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat(docs): Add pointer to shields folder in new shield docs

Browse source
This commit is contained in:
Cem Aksoylar 2024-02-27 11:41:46 -08:00
parent 849eca7228
commit 7a51a46b9f
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/docs/development/new-shield.mdx
View file

@ -67,6 +67,10 @@ mkdir boards/shields/<keyboard_name>
## Base Kconfig Files ## Base Kconfig Files
:::tip[Example shields]
You can check out the [`shields` folder](https://github.com/zmkfirmware/zmk/tree/main/app/boards/shields) in the ZMK repo that houses [the in-tree supported shields](../hardware.mdx) in order to copy and modify as a starting point.
:::
There are two required Kconfig files that need to be created for your new keyboard There are two required Kconfig files that need to be created for your new keyboard
shield to get it picked up for ZMK, `Kconfig.shield` and `Kconfig.defconfig`. shield to get it picked up for ZMK, `Kconfig.shield` and `Kconfig.defconfig`.