You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -9,36 +9,39 @@ A **work in progress** Cli tool to generate preview images from a zmk .keymap fi
9
9
## Usage
10
10
11
11
```shell
12
-
Usage: zmk-layout-viewer <keyboard>
12
+
Usage: zmk-viewer generate <keyboard-name>
13
+
14
+
Generate layout image.
13
15
14
16
Arguments:
15
-
<keyboard> Keyboard name to fetch layout.
17
+
<keyboard-name> Keyboard name to fetch layout.
16
18
17
19
Flags:
18
20
-h, --help Show context-sensitive help.
21
+
-D, --debug Enable debug mode
22
+
19
23
-f, --file=STRING ZMK .keymap file
20
24
-t, --transparent Use a transparent background.
21
25
-o, --output="." Output directory.
22
-
--debug Enable debug logging.
23
26
```
24
27
25
28
Keyboard name should be the same as in https://config.qmk.fm.
26
29
27
30
```shell
28
-
zmk-layout-viewer cradio
31
+
zmk-viewer generate cradio
29
32
```
30
33
Will output this image:
31
34
32
35

33
36
34
-
You can pass a .keymap file ([this one for reference](https://github.com/MrMarble/zmk-config/blob/master/config/cradio.keymap)) to generate the layout with bindings
37
+
You can pass a .keymap file ([this one for reference](https://github.com/zmkfirmware/zmk/blob/main/app/boards/shields/cradio/cradio.keymap)) to generate the layout with bindings
0 commit comments