Documentation improvements

This commit is contained in:
Andrey Nering
2018-10-07 18:34:03 -03:00
parent b5b2649283
commit b77fcd6c8a
3 changed files with 60 additions and 22 deletions

View File

@@ -1,12 +1,10 @@
# Installation
## Go
## Binary
If you have a [Golang][golang] environment setup, you can simply run:
```bash
go get -u -v github.com/go-task/task/cmd/task
```
Or you can download the binary from the [releases][releases] page and add to
your $PATH. DEB and RPM packages are also available.
The `task_checksums.txt` file contains the sha256 checksum for each file.
## Homebrew
@@ -27,23 +25,27 @@ right:
sudo snap install task
```
## Go
If you have a [Go][go] environment setup, you can simply run:
```bash
go get -u -v github.com/go-task/task/cmd/task
```
## Install script
We also have a [install script][installscript], which is very useful on
scanarios like CIs. Many thanks to [godownloader][godownloader] for easily
generating this script.
scanarios like CIs. Many thanks to [godownloader][godownloader] for allowing
easily generating this script.
```bash
curl -s https://taskfile.org/install.sh | sh
```
## Binary
> This method will download the binary on the local `./bin` directory by default.
Or you can download the binary from the [releases][releases] page and add to
your `PATH`. DEB and RPM packages are also available.
The `task_checksums.txt` file contains the sha256 checksum for each file.
[golang]: https://golang.org/
[go]: https://golang.org/
[snapcraft]: https://snapcraft.io/
[homebrew]: https://brew.sh/
[installscript]: https://github.com/go-task/task/blob/master/install-task.sh