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

docs: Add note about .keymap changes when using Studio

This commit is contained in:
Peter Johanson 2024-10-16 10:17:07 -06:00 committed by Pete Johanson
parent 993a64d5b3
commit c8841c4119
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -14,6 +14,14 @@ ZMK Studio provides runtime update functionality to ZMK powered devices, allowin
To unlock your keyboard to allow ZMK Studio to make changes, you'll need to add a [`&studio_unlock`](../keymaps/behaviors/studio-unlock.md) binding to the keymap.
:::note
Once using ZMK Studio to manage your keymap, any future changes made to the `.keymap` file for your keyboard will not be applied unless you perform a "Restore Stock Settings" action from the ZMK Studio UI.
Generally, if you intend to use ZMK Studio, then you should not make any further changes to the `.keymap` file (with the exception of adding new empty layers to then use within ZMK Studio).
:::
## Accessing ZMK Studio
You can use ZMK Studio with Chrome/Edge at https://zmk.studio/.