zmkfirmware
/
zmk
mirror of https://github.com/zmkfirmware/zmk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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

This commit is contained in:
Nicolas Munnich 2024-12-13 09:03:08 +00:00 committed by GitHub
parent 4ef231f4bb
commit ec6b770947
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/docs/development/hardware-integration/new-shield.mdx
View File

@ -544,6 +544,7 @@ See [Hardware Metadata Files](hardware-metadata-files.md) for the full details.
## Testing ## Testing
Once you've defined everything as described above, you can build your firmware to make sure everything is working. 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 ### GitHub Actions

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

@ -72,7 +72,8 @@ Building for ZMK Studio involves two main additional items.
### GitHub Actions ### 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.: For a split keyboard, you should do this _only_ for your central/left side, e.g.:
```yaml title="build.yaml" ```yaml title="build.yaml"
@ -81,16 +82,11 @@ include:
- board: nice_nano_v2 - board: nice_nano_v2
shield: corne_left shield: corne_left
snippet: studio-rpc-usb-uart snippet: studio-rpc-usb-uart
cmake-args: -DCONFIG_ZMK_STUDIO=y
- board: nice_nano_v2 - board: nice_nano_v2
shield: corne_right 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 ### 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.: 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.: