From 6c18ac9e2fc1ce6c8c6d007d3399b7edf07980d6 Mon Sep 17 00:00:00 2001 From: Marc Cataford Date: Mon, 3 Jun 2024 00:32:04 -0400 Subject: [PATCH] docs: document where binaries can be obtained --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5c05e56..ecb3ceb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ # spud -Service management tooling \ No newline at end of file +Service management tooling + +## Setup + +Regardless of how you obtain your binary of choice, include it in your `$PATH` and you are good to go! + +### Building from source + +`spud` can be built from source by checking out the commit of your choosing and `go build .`. + +### Pre-built binaries + +The [releases](https://forge.karnov.club/spadinastan/spud/releases) page contains pre-built binaries that can be downloaded. These are built on tag-push.