xenua
/
zmk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

docs: Clarifications within New Shield page (#1130) 

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
xmkb
chadbailey59 3 years ago committed by GitHub
parent
8e91e5ada1
commit
43ffa6c760
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 10
      docs/docs/development/new-shield.md

10
docs/docs/development/new-shield.md
Unescape View File

@ -48,16 +48,16 @@ shield to get it picked up for ZMK, `Kconfig.shield` and `Kconfig.defconfig`.
### Kconfig.shield ### 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 config SHIELD_MY_BOARD
def_bool $(shields_list_contains,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 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 if SHIELD_MY_BOARD
config ZMK_KEYBOARD_NAME config ZMK_KEYBOARD_NAME
default "My Awesome Keyboard" default "My Board"
endif 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 if SHIELD_MY_BOARD_LEFT
config ZMK_KEYBOARD_NAME config ZMK_KEYBOARD_NAME
default "My Awesome Keyboard" default "My Board"
config ZMK_SPLIT_BLE_ROLE_CENTRAL config ZMK_SPLIT_BLE_ROLE_CENTRAL
default y default y

Write Preview
Loading…
Cancel
Save