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

Add guide to build additional keyboards with GH Action

Browse source
This commit is contained in:
Albert Y 2022-02-11 10:43:10 +08:00
parent cfd0d3d81a
commit 4f78a4164d
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/docs/customization.md
View file

@ -56,3 +56,21 @@ For normal keyboards, follow the same flashing instructions as before to flash y
For split keyboards, only the central (left) side will need to be reflashed if you are just updating your keymap.
More troubleshooting information for split keyboards can be found [here](troubleshooting.md#split-keyboard-halves-unable-to-pair).
## Building Additional Keyboards
You can build additional keyboards with GitHub actions by appending them to `build.yml` in your `zmk-config` folder. The following example will build Corne with Nice!Nano and Lily58 with Nice!Nano v2:
```
include:
- board: nice_nano
shield: corne_left
- board: nice_nano
shield: corne_right
- board: nice_nano_v2
shield: lily58_left
- board: nice_nano_v2
shield: lily58_right
```
Lily58 specific shield files, e.g. `lily58.conf` and `lily58.keymap` should be added into the `config` sub-folder inside `zmk-config`.