From 98e314baf2d8c936159175b2787f3f7d7a5527a8 Mon Sep 17 00:00:00 2001 From: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com> Date: Tue, 12 Nov 2024 19:08:23 +0100 Subject: [PATCH] docs: Added permissions note for ZMK Studio USB use (#2638) --- docs/docs/features/studio.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/docs/features/studio.md b/docs/docs/features/studio.md index ced09bc3..f2419d9a 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.