From 43ffa6c76077a446ee0ebc8ebc39ebc09eae4b57 Mon Sep 17 00:00:00 2001 From: chadbailey59 Date: Wed, 16 Feb 2022 05:46:15 -0600 Subject: [PATCH] docs: Clarifications within New Shield page (#1130) Co-authored-by: Cem Aksoylar --- docs/docs/development/new-shield.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/docs/development/new-shield.md b/docs/docs/development/new-shield.md index 6f65d869..26542310 100644 --- a/docs/docs/development/new-shield.md +++ b/docs/docs/development/new-shield.md @@ -48,16 +48,16 @@ shield to get it picked up for ZMK, `Kconfig.shield` and `Kconfig.defconfig`. ### Kconfig.shield -The `Kconfig.shield` file defines any additional Kconfig settings that may be relevant when using this keyboard. For most keyboards, there is just one additional configuration value for the shield itself, e.g.: +The `Kconfig.shield` file defines any additional Kconfig settings that may be relevant when using this keyboard. For most keyboards, there is just one additional configuration value for the shield itself. ``` config SHIELD_MY_BOARD def_bool $(shields_list_contains,my_board) ``` -This will make sure the new configuration `SHIELD_MY_BOARD` is set to true whenever `my_board` is added as a shield in your build. +This will make sure that a new configuration value named `SHIELD_MY_BOARD` is set to true whenever `my_board` is used as the shield name, either as the `SHIELD` variable [in a local build](build-flash.md) or in your `build.yaml` file [when using Github Actions](../customization). Note that this configuration value will be used in `Kconfig.defconfig` to set other properties about your shield, so make sure that they match. -**For split boards**, you will need to add configurations for the left and right sides. +**For split boards**, you will need to add configurations for the left and right sides. For example, if your split halves are named `my_board_left` and `my_board_right`, it would look like this: ``` config SHIELD_MY_BOARD_LEFT @@ -84,7 +84,7 @@ Do not make the keyboard name too long, otherwise the bluetooth advertising migh if SHIELD_MY_BOARD config ZMK_KEYBOARD_NAME - default "My Awesome Keyboard" + default "My Board" endif ``` @@ -98,7 +98,7 @@ Finally, you'll want to turn on the split option for both sides. This can all be if SHIELD_MY_BOARD_LEFT config ZMK_KEYBOARD_NAME - default "My Awesome Keyboard" + default "My Board" config ZMK_SPLIT_BLE_ROLE_CENTRAL default y