Skip to content

Commit

Permalink
feat(docs): Add pointer to shields folder in new shield docs
Browse files Browse the repository at this point in the history
  • Loading branch information
caksoylar committed Apr 9, 2024
1 parent 849eca7 commit 7a51a46
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/docs/development/new-shield.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ mkdir boards/shields/<keyboard_name>

## 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
shield to get it picked up for ZMK, `Kconfig.shield` and `Kconfig.defconfig`.

Expand Down

0 comments on commit 7a51a46

Please sign in to comment.