Skip to content

Commit

Permalink
fix(docs): Fix text blurb about split Kconfig.defconfig
Browse files Browse the repository at this point in the history
  • Loading branch information
caksoylar committed Dec 7, 2023
1 parent 09d47d8 commit 384637a
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/docs/development/new-shield.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,11 @@ config ZMK_KEYBOARD_NAME
endif
```

Similarly to defining the halves of a split board in `Kconfig.shield` it is important to set the `ZMK_KEYBOARD_NAME` for each half of a split keyboard.
You'll also want to set which half is the central side. Most boards set it to the left.
Then on the peripheral half, you'll want to turn USB on so that it shows USB status on displays properly.
Finally, you'll want to turn on the split option for both sides. This can all be seen below.
For split keyboards, `Kconfig.defconfig` needs to specify a few more options.
Which side is central (usually the left) is determined via the configuration in this file.
For that side, the keyboard name is assigned and the central config is set.
The peripheral side is typically not assigned a name since only the central will be advertising for connections to other devices.
Finally, the split config needs to be set for both sides:

```kconfig
if SHIELD_MY_BOARD_LEFT
Expand Down

0 comments on commit 384637a

Please sign in to comment.