Skip to content

Commit

Permalink
docs: Minor touchups to studio related bits (#2707)
Browse files Browse the repository at this point in the history
  • Loading branch information
Nick-Munnich authored Dec 13, 2024
1 parent 4ef231f commit ec6b770
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 7 deletions.
1 change: 1 addition & 0 deletions docs/docs/development/hardware-integration/new-shield.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -544,6 +544,7 @@ See [Hardware Metadata Files](hardware-metadata-files.md) for the full details.
## Testing

Once you've defined everything as described above, you can build your firmware to make sure everything is working.
If you wish to test that your keyboard works with [ZMK Studio](../../features/studio.md), you'll also need to follow the [instructions for enabling Studio](../../features/studio.md#building).

### GitHub Actions

Expand Down
10 changes: 3 additions & 7 deletions docs/docs/features/studio.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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.:
Expand Down

0 comments on commit ec6b770

Please sign in to comment.