kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix(docs): Fix text blurb about split Kconfig.defconfig

Browse source
This commit is contained in:
Cem Aksoylar 2023-12-03 22:36:04 -08:00
parent 09d47d8117
commit 384637ae6c
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/docs/development/new-shield.md
View file

@ -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