diff options
| author | Nicolas Munnich <[email protected]> | 2024-12-13 09:03:08 +0000 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-12-13 10:03:08 +0100 |
| commit | ec6b770947d9514490bda6f9d6522e9b1f04fdc9 (patch) | |
| tree | bf31251e28d3c197131e60705c8bd5a73382980d | |
| parent | 4ef231f4bba87151acfbd1cf3babd83b69813e45 (diff) | |
| download | zmk-ec6b770947d9514490bda6f9d6522e9b1f04fdc9.tar.gz zmk-ec6b770947d9514490bda6f9d6522e9b1f04fdc9.zip | |
docs: Minor touchups to studio related bits (#2707)
| -rw-r--r-- | docs/docs/development/hardware-integration/new-shield.mdx | 1 | ||||
| -rw-r--r-- | docs/docs/features/studio.md | 10 |
2 files changed, 4 insertions, 7 deletions
diff --git a/docs/docs/development/hardware-integration/new-shield.mdx b/docs/docs/development/hardware-integration/new-shield.mdx index 6ad57e3188..5f532ab800 100644 --- a/docs/docs/development/hardware-integration/new-shield.mdx +++ b/docs/docs/development/hardware-integration/new-shield.mdx @@ -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 diff --git a/docs/docs/features/studio.md b/docs/docs/features/studio.md index 9c4daa3188..9eb0d7e51a 100644 --- a/docs/docs/features/studio.md +++ b/docs/docs/features/studio.md @@ -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.: |