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

Merge branch 'dongle-doc' of github.com:RasmusKoit/zmk into dongle-doc

Browse source
This commit is contained in:
rasmuskoit 2024-08-11 21:20:55 +03:00
commit 9a94cc77a9
No known key found for this signature in database
GPG key ID: 99709B876A0CD268
1 changed files with 6 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
docs/docs/features/dongle.mdx
View file

@ -175,32 +175,17 @@ CONFIG_ZMK_SPLIT=y
## Building the firmware
:::note
Start by flashing the `settings_reset` firmware on all the devices.
:::warning
Before flashing your new firmware, flash the `settings_reset` firmware on all devices.
:::
For a split keyboard, you can modify the `build.yml` file to include the dongle configuration.
Add the appropriate lines to your `build.yml` file to build the firmware for your dongle, in addition to the other parts of your keyboard.
```yaml
include:
- board: nice_nano_v2
shield: my_keyboard_left
- board: nice_nano_v2
shield: my_keyboard_right
# -----------------------------------------
# Your other keyboard parts here
# -----------------------------------------
- board: nice_nano_v2
shield: my_keyboard_dongle
- board: nice_nano_v2
shield: settings_reset
```
For a unibody keyboard, you can modify the `build.yml` file to include the dongle configuration.
```yaml
include:
- board: nice_nano_v2
shield: my_keyboard
- board: nice_nano_v2
shield: my_keyboard_dongle
- board: nice_nano_v2
shield: settings_reset
```