diff --git a/README.md b/README.md index e082944..5896d7b 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,17 @@ Arguments: Keyboard name to fetch layout. Flags: - -h, --help Show context-sensitive help. - -D, --debug Enable debug mode - --version Print version information and quit - - -f, --file=STRING ZMK .keymap file - -t, --transparent Use a transparent background. - -o, --output="." Output directory. + -h, --help Show context-sensitive help. + -D, --debug Enable debug mode + --version Print version information and quit + + -f, --file=STRING ZMK .keymap file + -l, --layout-file=STRING info.json file + -t, --transparent Use a transparent background. + -r, --raw Draw the ZMK codes instead of the key labels. + -s, --single Generate a single image. + -u, --unified Generate a single image with all the layers. + -o, --output="." Output directory. ``` Keyboard name should be the same as in https://config.qmk.fm. @@ -58,16 +62,37 @@ zmk-viewer generate cradio ``` Will output this image: -![](assets/cradio.png) +![](assets/cradio_split_3x5_2.png) 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 + +### Normal + ```shell zmk-viewer generate -f ~/zmk-config/config/cradio.keymap cradio ``` will output an image for each layer: -![](assets/cradio_default_layer.png) -![](assets/cradio_left_layer.png) -![](assets/cradio_right_layer.png) -![](assets/cradio_tri_layer.png) +![](assets/cradio_split_3x5_2_default_layer.png) +![](assets/cradio_split_3x5_2_left_layer.png) +![](assets/cradio_split_3x5_2_right_layer.png) +![](assets/cradio_split_3x5_2_tri_layer.png) + +### Single + +```shell +zmk-viewer generate -f ~/zmk-config/config/cradio.keymap cradio --single +``` +will output one image with all layers: + +![](assets/single.png) + +### Unified + +```shell +zmk-viewer generate -f ~/zmk-config/config/cradio.keymap cradio --unified +``` +will output one image with all layers stacked: + +![](assets/unified.png) diff --git a/assets/cradio.png b/assets/cradio.png index ece6146..41bf59c 100644 Binary files a/assets/cradio.png and b/assets/cradio.png differ diff --git a/assets/cradio_split_3x5_2.png b/assets/cradio_split_3x5_2.png new file mode 100644 index 0000000..5def9c3 Binary files /dev/null and b/assets/cradio_split_3x5_2.png differ diff --git a/assets/cradio_split_3x5_2_default_layer.png b/assets/cradio_split_3x5_2_default_layer.png new file mode 100644 index 0000000..283fae1 Binary files /dev/null and b/assets/cradio_split_3x5_2_default_layer.png differ diff --git a/assets/cradio_split_3x5_2_left_layer.png b/assets/cradio_split_3x5_2_left_layer.png new file mode 100644 index 0000000..843b47a Binary files /dev/null and b/assets/cradio_split_3x5_2_left_layer.png differ diff --git a/assets/cradio_split_3x5_2_right_layer.png b/assets/cradio_split_3x5_2_right_layer.png new file mode 100644 index 0000000..7607561 Binary files /dev/null and b/assets/cradio_split_3x5_2_right_layer.png differ diff --git a/assets/cradio_split_3x5_2_tri_layer.png b/assets/cradio_split_3x5_2_tri_layer.png new file mode 100644 index 0000000..189cd92 Binary files /dev/null and b/assets/cradio_split_3x5_2_tri_layer.png differ diff --git a/assets/single.png b/assets/single.png new file mode 100644 index 0000000..eeefe46 Binary files /dev/null and b/assets/single.png differ diff --git a/assets/unified.png b/assets/unified.png new file mode 100644 index 0000000..41bf59c Binary files /dev/null and b/assets/unified.png differ