Jacob/zmk
1
0
Fork 0
forked from kofal.net/zmk
Code Pull Requests Activity

docs: Minor touchups to studio related bits (#2707)

Browse Source
This commit is contained in:
Nicolas Munnich
2024-12-13 09:03:08 +00:00
committed by GitHub
parent 4ef231f4bb
commit ec6b770947
2 changed files with 4 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/docs/features/studio.md
View File

@@ -72,7 +72,8 @@ Building for ZMK Studio involves two main additional items.
### GitHub Actions
First add a `studio-rpc-usb-uart` to the `snippet` property of your build configuration, in the `build.yaml` file at the root of your user config.
Add a `studio-rpc-usb-uart` to the `snippet` property of your build configuration, in the `build.yaml` file at the root of your user config. Enabling the `ZMK_STUDIO` Kconfig setting can also be done from the `build.yaml` file using the `cmake-args` property.
For a split keyboard, you should do this _only_ for your central/left side, e.g.:
```yaml title="build.yaml"
@@ -81,16 +82,11 @@ include:
- board: nice_nano_v2
shield: corne_left
snippet: studio-rpc-usb-uart
cmake-args: -DCONFIG_ZMK_STUDIO=y
- board: nice_nano_v2
shield: corne_right
```
Next, enable the `ZMK_STUDIO` Kconfig symbol, for example by adding the following line to your .conf file:
```
CONFIG_ZMK_STUDIO=y
```
### Local Build
When building locally, use the `-S` parameter to include the `studio-rpc-usb-uart` snippet. Instead of adding it to your config file, you can also append the `ZMK_STUDIO` Kconfig as an additional CMake argument, e.g.: