~whereswaldon/gover

daf49948662181e1cd8c207b15340ac2a165a794 — Chris Waldon 8 months ago
docs: add README
1 files changed, 35 insertions(+), 0 deletions(-)

A README.md
A  => README.md +35 -0
@@ 1,35 @@
# gover

A simple shell script for installing and switching between go versions
on Linux. Minor tweaks required for macOS and *BSD support.

## Prerequisites

You must have a conventional `PREFIX` directory structure with its `bin`
directory earlier in your `$PATH` than any other `go` installation.

Pretty much every linux distro creates this for you at `~/.local`, which is
the default installation directory. Make sure you update your `$PATH` so
that `~/.local/bin` is towards the beginning.

## Install

Download the script and put it into any `bin` directory that is in your `$PATH`.
If you're using the default installation prefix, `~/.local/bin` will do.

```
curl -o ~/.local/bin/gover https://git.sr.ht/~whereswaldon/gover/tree/main/gover
chmod +x ~/.local/bin/gover
```

## Usage

```
gover <minor> <patch>
```

This will activate go 1.<minor>.<patch> (installing it if needed).

## License

Dual MIT/Unlicense