docs: Add binary installation instructions

Signed-off-by: Tim Hårek Andreassen <tim@harek.no>
This commit is contained in:
Tim Hårek Andreassen 2024-10-03 20:19:57 +02:00
parent eb8e643804
commit eb09d76ad0
No known key found for this signature in database
GPG key ID: E59C7734F0E10EB5

View file

@ -13,6 +13,20 @@ Using go: `go install git.sr.ht/~timharek/yr`
Adding more methods in the future. Help is wanted to achieve the best coverage.
### Using pre-compiled binary
Select the version you want to install [available releases] and download
it and add it to your `bin` or something similar.
Example:
```bash
wget https://git.sr.ht/~timharek/yr/refs/download/<release>/yr-<version>-linux-amd64.tar.gz
tar xf yr-<version>-linux-amd64.tar.gz
cd yr-<version>
cp yr /usr/local/bin
```
## Usage
```bash
@ -66,3 +80,4 @@ Send patches to the [mailing list], report bugs on the [issue tracker].
[mailing list]: https://lists.sr.ht/~timharek/yr
[issue tracker]: https://todo.sr.ht/~timharek/yr
[contribution guidelines]: ./CONTRIBUTING.md
[available releases]: https://git.sr.ht/~timharek/yr/refs