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

docs: Document requirements-extra.txt and endpoint selection for Studio (#3001) 

* docs: Document requirements-extra.txt for Studio builds

* docs: Note endpoint selection requirement for Studio

* docs: Fix indents in list items in native setup page

Add this file to .prettierignore because it messes all the additional indents.
There is also no way to make prettier ignore a range of lines in MDX files AFAICT.

* Revert "docs: Fix indents in list items in native setup page"

This reverts commit 6d8aeba801.
This commit is contained in:
Cem Aksoylar 2025-07-21 08:11:06 -07:00 committed by GitHub
parent 342d838913
commit 61325ee82c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/docs/development/local-toolchain/setup/native.mdx
View File

@ -203,6 +203,12 @@ west zephyr-export
pip install -r zephyr/scripts/requirements-base.txt pip install -r zephyr/scripts/requirements-base.txt
``` ```
If you are going to build firmware with [ZMK Studio](../../../features/studio.md), also install `requirements-extra.txt` dependencies:
```sh
pip install -r zephyr/scripts/requirements-extra.txt
```
</TabItem> </TabItem>
<TabItem value="glob"> <TabItem value="glob">
<Tabs groupId="operating-systems" queryString defaultValue="ubuntu"> <Tabs groupId="operating-systems" queryString defaultValue="ubuntu">
@ -293,6 +299,12 @@ west zephyr-export
```sh ```sh
pip3 install --user -r zephyr/scripts/requirements-base.txt pip3 install --user -r zephyr/scripts/requirements-base.txt
```
If you are going to build firmware with [ZMK Studio](../../../features/studio.md), also install `requirements-extra.txt` dependencies:
```sh
pip3 install -r zephyr/scripts/requirements-extra.txt
``` ```
</TabItem> </TabItem>
@ -303,6 +315,12 @@ pip3 install --user -r zephyr/scripts/requirements-base.txt
```sh ```sh
pip install -r zephyr/scripts/requirements-base.txt pip install -r zephyr/scripts/requirements-base.txt
```
If you are going to build firmware with [ZMK Studio](../../../features/studio.md), also install `requirements-extra.txt` dependencies:
```sh
pip install -r zephyr/scripts/requirements-extra.txt
``` ```
</TabItem> </TabItem>
@ -312,6 +330,12 @@ pip install -r zephyr/scripts/requirements-base.txt
```sh ```sh
pip3 install -r zephyr/scripts/requirements-base.txt pip3 install -r zephyr/scripts/requirements-base.txt
```
If you are going to build firmware with [ZMK Studio](../../../features/studio.md), also install `requirements-extra.txt` dependencies:
```sh
pip3 install -r zephyr/scripts/requirements-extra.txt
``` ```
</TabItem> </TabItem>

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

@ -64,6 +64,13 @@ To use ZMK Studio over USB, you need permission to access the USB serial port. T
::: :::
:::note
If you are connected to the computer over both USB and BLE endpoints, you should set the keyboard output to the same endpoint that you connect to ZMK Studio using.
For example, if you are connecting to ZMK Studio over USB, ensure that USB output is selected by invoking the `&out OUT_USB` [behavior](../keymaps/behaviors/outputs.md).
:::
## Building ## Building
Building for ZMK Studio involves two main additional items. Building for ZMK Studio involves two main additional items.