Skip to content

Commit

Permalink
docs: Document how to update to latest version
Browse files Browse the repository at this point in the history
Added a section to the readme showing how to update ZMK CLI.
  • Loading branch information
joelspadin committed Oct 20, 2024
1 parent 9d90d74 commit cc89ad4
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,14 @@ It should print a help message if everything installed correctly.

On Linux, you may get an error saying you need to install another package such as `python3.10-venv`. If so, follow the instructions in the error message, then try the above commands again.

## Update ZMK CLI

If you have already installed ZMK CLI, you can update to the latest version with the following command:

```sh
pipx upgrade zmk
```

# Usage

All ZMK CLI commands start with `zmk`. Run `zmk --help` for general usage instructions. For help with a specific subcommand, add `--help` after the subcommand, e.g. `zmk init --help`.
Expand Down

0 comments on commit cc89ad4

Please sign in to comment.