Skip to content

Commit

Permalink
doc: add keymap-drawer commands dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
JeffDess committed Jan 14, 2025
1 parent 9b1dde9 commit 6af5b40
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,23 +92,34 @@ whenever I switch keyboards.

## Scripts

1. Export an image of the keymap:
First make sure to setup ZMK Helpers module:

```sh
git submodule update --init --recursive
```

Then these commands will be available:

- Export an image of the keymap:

```sh
make drawing
```

1. Export an image of the keymap and open in browser:
- Export an image of the keymap and open in browser:

```sh
make preview
```

1. Download firmware and open file explorer:
### Github Action artefact

Download firmware and open file explorer:

```sh
make download
```

```sh
make download
```

## References

Expand Down

0 comments on commit 6af5b40

Please sign in to comment.