aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorNicolas Munnich <[email protected]>2024-11-12 19:08:23 +0100
committerGitHub <[email protected]>2024-11-12 10:08:23 -0800
commit98e314baf2d8c936159175b2787f3f7d7a5527a8 (patch)
treebd3f7705640cad63dc9fa0122e1c7868da952985
parentc7473fc32557d2d384ab78d3acf51a05488f0214 (diff)
downloadzmk-98e314baf2d8c936159175b2787f3f7d7a5527a8.tar.gz
zmk-98e314baf2d8c936159175b2787f3f7d7a5527a8.zip
docs: Added permissions note for ZMK Studio USB use (#2638)
-rw-r--r--docs/docs/features/studio.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/docs/features/studio.md b/docs/docs/features/studio.md
index ced09bc3ca..f2419d9a83 100644
--- a/docs/docs/features/studio.md
+++ b/docs/docs/features/studio.md
@@ -51,6 +51,12 @@ You can use ZMK Studio with Chrome/Edge at https://zmk.studio/.
To use the native app for Linux, macOS, or Windows, download the appropriate file from the [latest release](https://github.com/zmkfirmware/zmk-studio/releases).
+:::warning
+
+To use ZMK Studio over USB, you need permission to access the USB serial port. This most commonly occurs on Linux, with various distributions having different methods of resolving the error. For example, you may need to be added to a `uucp` or a `dialout` group. Refer to your operating system's documentation for more information.
+
+:::
+
## Building
Building for ZMK Studio involves two main additional items.