Skip to content

Commit c134303

Browse files
committed
doc: update usage
1 parent 37ca158 commit c134303

File tree

8 files changed

+14
-11
lines changed

8 files changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ZMK Layout viewer
1+
# ZMK viewer
22

33
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/mrmarble/zmk-layout-viewer)
44
[![Vuln](https://github.com/MrMarble/zmk-layout-viewer/actions/workflows/vuln.yml/badge.svg)](https://github.com/MrMarble/zmk-layout-viewer/actions/workflows/vuln.yml)
@@ -9,36 +9,39 @@ A **work in progress** Cli tool to generate preview images from a zmk .keymap fi
99
## Usage
1010

1111
```shell
12-
Usage: zmk-layout-viewer <keyboard>
12+
Usage: zmk-viewer generate <keyboard-name>
13+
14+
Generate layout image.
1315

1416
Arguments:
15-
<keyboard> Keyboard name to fetch layout.
17+
<keyboard-name> Keyboard name to fetch layout.
1618

1719
Flags:
1820
-h, --help Show context-sensitive help.
21+
-D, --debug Enable debug mode
22+
1923
-f, --file=STRING ZMK .keymap file
2024
-t, --transparent Use a transparent background.
2125
-o, --output="." Output directory.
22-
--debug Enable debug logging.
2326
```
2427

2528
Keyboard name should be the same as in https://config.qmk.fm.
2629

2730
```shell
28-
zmk-layout-viewer cradio
31+
zmk-viewer generate cradio
2932
```
3033
Will output this image:
3134

3235
![](assets/layout.png)
3336

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
3538

3639
```shell
37-
zmk-layout-viewer -f ~/zmk-config/config/cradio.keymap cradio
40+
zmk-viewer generate -f ~/zmk-config/config/cradio.keymap cradio
3841
```
3942
will output an image for each layer:
4043

41-
![](assets/default_layer.png)
42-
![](assets/left_layer.png)
43-
![](assets/right_layer.png)
44-
![](assets/tri_layer.png)
44+
![](assets/cradio_default_layer.png)
45+
![](assets/cradio_left_layer.png)
46+
![](assets/cradio_right_layer.png)
47+
![](assets/cradio_tri_layer.png)
File renamed without changes.

assets/cradio_left_layer.png

20.6 KB
Loading

assets/cradio_right_layer.png

21.7 KB
Loading

assets/left_layer.png

-20.4 KB
Binary file not shown.

assets/right_layer.png

-21.7 KB
Binary file not shown.

0 commit comments

Comments
 (0)