Skip to content

Commit

Permalink
docs(README): add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
MrMarble committed May 8, 2022
1 parent 5d28314 commit f1d6c4c
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,31 @@

A **work in progress** Cli tool to generate preview images from a zmk .keymap file.


## Installation

You can download a pre compiled binary directly from the [releases](https://github.com/mrmarble/zmk-viewer/releases) for your OS/Architecture.
### Linux/MacOS

I made an [installation script](/scripts/install.sh) that should download the latest available version corresponding to your OS and architecture. `sudo` is needed to copy the binary to `/usr/local/bin`

```sh
curl -sL https://raw.githubusercontent.com/MrMarble/zmk-viewer/master/scripts/install.sh | sudo -E bash -
# or with wget
wget -O - https://raw.githubusercontent.com/MrMarble/zmk-viewer/master/scripts/install.sh | sudo -E bash -
```

### Windows

Download the executable directly from the [releases](https://github.com/mrmarble/zmk-viewer/releases)

### Others

If you already have Go in your system you can use go install to build the binary without cloning the repo first.

```sh
go install github.com/mrmarble/zmk-viewer/cmd/zmk-viewer@latest # or target a specific version @v0.1.0
```
## Usage

```shell
Expand All @@ -19,6 +44,7 @@ Arguments:
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.
Expand Down

0 comments on commit f1d6c4c

Please sign in to comment.