Skip to content

Commit

Permalink
docs: added install instructions (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
belitre authored Jun 6, 2024
1 parent 9e23dfe commit 51b3145
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ I do this for fun and on my free time, so if you have any issues or suggestions,

The first thing you need to know is: **don't use `go install github.com/belitre/canu`, that would add `canu` as an executable to your `$GOPATH/bin` with name `canu`, and we don't want that!**

* Download the binary for your OS/ARCH from the release page and unpack it in a folder available in your `$PATH`
* Download the binary for your OS/ARCH from the release page and unpack it in a folder available in your `$PATH` (I'll use for the example `$GOPATH/bin`):
```
curl -sL https://github.com/belitre/canu/releases/download/1.0.0/canu-1.0.0-darwin-arm64.tar.gz | tar -zxf - -C $GOPATH/bin
```
* Run `_canu install` (more details about flags incoming!)
* Restart your shell, or run the alias returned in the `_canu install` output.
* Use your alias and enjoy!
* Run `canu` and enjoy!

0 comments on commit 51b3145

Please sign in to comment.