aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorPeter Johanson <[email protected]>2024-10-16 17:49:54 -0600
committerPete Johanson <[email protected]>2024-10-17 10:20:30 -0600
commit64c1e1e3ff0ad52226cc32d30a7a2a6b70924662 (patch)
tree5b493861b9d79bae652a3b37dfc66cff7d4c22d9
parent7dfc6ab31dc3a7693efeb9f81d34fb9e3721cd8d (diff)
downloadzmk-64c1e1e3ff0ad52226cc32d30a7a2a6b70924662.tar.gz
zmk-64c1e1e3ff0ad52226cc32d30a7a2a6b70924662.zip
feat: Add `studio` as a feature option in metadata
* Allow boards/shields to indicate ZMK Studio support in the `features` list.
-rw-r--r--docs/docs/development/hardware-integration/hardware-metadata-files.md1
-rw-r--r--schema/hardware-metadata.schema.json3
2 files changed, 3 insertions, 1 deletions
diff --git a/docs/docs/development/hardware-integration/hardware-metadata-files.md b/docs/docs/development/hardware-integration/hardware-metadata-files.md
index 46fad411ab..13f51b55d0 100644
--- a/docs/docs/development/hardware-integration/hardware-metadata-files.md
+++ b/docs/docs/development/hardware-integration/hardware-metadata-files.md
@@ -95,6 +95,7 @@ Boards and shields should document the sets of hardware features found on them u
- `encoder` - Indicates the hardware contains one or more rotary encoders.
- `underglow` - Indicates the hardware includes underglow LEDs.
- `backlight` - Indicates the hardware includes backlight LEDs.
+- `studio` - Indicates the keyboard is ready to use with [ZMK Studio](../../features/studio.md).
- `pointer` (future) - Used to indicate the hardware includes one or more pointer inputs, e.g. joystick, touchpad, or trackpoint.
### Siblings
diff --git a/schema/hardware-metadata.schema.json b/schema/hardware-metadata.schema.json
index 9710c79239..e574ca8c73 100644
--- a/schema/hardware-metadata.schema.json
+++ b/schema/hardware-metadata.schema.json
@@ -57,7 +57,8 @@
"encoder",
"underglow",
"backlight",
- "pointer"
+ "pointer",
+ "studio"
]
}
},