@ -32,7 +32,7 @@ This guide describes how to add shield to the ZMK main repository. If you are bu
@@ -32,7 +32,7 @@ This guide describes how to add shield to the ZMK main repository. If you are bu
own prototype or handwired keyboard, it is recommended to use your own user config repository. Follow the
[user setup guide](./user-setup.md) to create your user config repository first. When following the rest
of this guide, replace the `app/` directory in the ZMK main repository with the `config/` directory in your
user config repository. Form example, `app/boards/shields/<keyboard_name>` should now be
user config repository. For example, `app/boards/shields/<keyboard_name>` should now be
@ -24,6 +24,13 @@ It is recommended to only enable logging when needed, and not leaving it on by d
@@ -24,6 +24,13 @@ It is recommended to only enable logging when needed, and not leaving it on by d
The following KConfig values need to be set, either by copy and pasting into the `app/prj.conf` file, or by running
`west build -t menuconfig` and manually enabling the various settings in that UI.
:::note
If you are debugging your own keyboard in your [user config repository](./user-setup.md), use
`config/boards/shields/<your_keyboard>/<your_keyboard>.conf` instead of `app/prj.conf`. In Github
Actions, you can search the `Kconfig file` build log to verify the options above have been enabled
for you successfully.
:::
```
# Turn on logging, and set ZMK logging to debug output