search

MrMarble / zmk-viewer

cli tool to generate preview images from a zmk .keymap file
MIT License
139 stars 7 forks source link

Add build/install instructions #6

Closed notfed closed 2 years ago

notfed commented 2 years ago

This project sounds great but I have no idea how to build or install it.

MrMarble commented 2 years ago

Thank you for your feedback! I should improve the README, I've been busy with other projects...

Installation is simple, just download the portable executable for your operating system from https://github.com/MrMarble/zmk-viewer/releases, extract it and run it from the command line.

If you want to build it yourself, you need Go, simply clone the repo and run go build ./cmd/zmk-viewer