Skip to content

Commit b91340a

Browse files
committed
docs: update readme
1 parent 5553dea commit b91340a

9 files changed

+37
-12
lines changed

README.md

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,17 @@ Arguments:
4242
<keyboard-name> Keyboard name to fetch layout.
4343

4444
Flags:
45-
-h, --help Show context-sensitive help.
46-
-D, --debug Enable debug mode
47-
--version Print version information and quit
48-
49-
-f, --file=STRING ZMK .keymap file
50-
-t, --transparent Use a transparent background.
51-
-o, --output="." Output directory.
45+
-h, --help Show context-sensitive help.
46+
-D, --debug Enable debug mode
47+
--version Print version information and quit
48+
49+
-f, --file=STRING ZMK .keymap file
50+
-l, --layout-file=STRING info.json file
51+
-t, --transparent Use a transparent background.
52+
-r, --raw Draw the ZMK codes instead of the key labels.
53+
-s, --single Generate a single image.
54+
-u, --unified Generate a single image with all the layers.
55+
-o, --output="." Output directory.
5256
```
5357

5458
Keyboard name should be the same as in https://config.qmk.fm.
@@ -58,16 +62,37 @@ zmk-viewer generate cradio
5862
```
5963
Will output this image:
6064

61-
![](assets/cradio.png)
65+
![](assets/cradio_split_3x5_2.png)
6266

6367
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
6468

69+
70+
### Normal
71+
6572
```shell
6673
zmk-viewer generate -f ~/zmk-config/config/cradio.keymap cradio
6774
```
6875
will output an image for each layer:
6976

70-
![](assets/cradio_default_layer.png)
71-
![](assets/cradio_left_layer.png)
72-
![](assets/cradio_right_layer.png)
73-
![](assets/cradio_tri_layer.png)
77+
![](assets/cradio_split_3x5_2_default_layer.png)
78+
![](assets/cradio_split_3x5_2_left_layer.png)
79+
![](assets/cradio_split_3x5_2_right_layer.png)
80+
![](assets/cradio_split_3x5_2_tri_layer.png)
81+
82+
### Single
83+
84+
```shell
85+
zmk-viewer generate -f ~/zmk-config/config/cradio.keymap cradio --single
86+
```
87+
will output one image with all layers:
88+
89+
![](assets/single.png)
90+
91+
### Unified
92+
93+
```shell
94+
zmk-viewer generate -f ~/zmk-config/config/cradio.keymap cradio --unified
95+
```
96+
will output one image with all layers stacked:
97+
98+
![](assets/unified.png)

assets/cradio.png

29.5 KB
Loading

assets/cradio_split_3x5_2.png

10.7 KB
Loading
20.2 KB
Loading
17.7 KB
Loading
19.6 KB
Loading
19.5 KB
Loading

assets/single.png

87.9 KB
Loading

assets/unified.png

37.1 KB
Loading

0 commit comments

Comments
 (0)