Skip to content
This repository was archived by the owner on Apr 28, 2020. It is now read-only.

Commit 066ed42

Browse files
author
Nathan Potter
authored
Merge pull request #148 from cdr/explicit-install-docs
Add more explicit install instructions to the docs
2 parents 90f9b3b + f267465 commit 066ed42

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

site/content/docs/installation.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,25 @@ Before using Sail, there are several dependencies that must be installed on the
2222

2323
### Stable Releases
2424

25-
It's recommended that user's install the sail binary from the stable releases.
25+
It's recommended that users install the sail binary from the stable releases.
2626

27-
Binary releases can be downloaded from our [GitHub.](https://github.com/cdr/sail/releases)
27+
You can download and untar the binary to your current working directory by running the following command with the download URL for your platform.
28+
29+
The download URLs can be found on our [releases page](https://github.com/cdr/sail/releases).
30+
```
31+
curl -L <DOWNLOAD_URL> | tar -C ./ -xv
32+
```
33+
34+
After installing, you can move the binary to your [PATH](https://superuser.com/questions/284342/what-are-path-and-other-environment-variables-and-how-can-i-set-or-use-them) in order
35+
to use Sail from anywhere in your terminal.
2836

2937
### From Source
3038

31-
To install the latest version of `sail`, you'll need [go](https://golang.org/) installed and configured on your system.
39+
For more **advanced users** who want to install the latest version from master, you can install Sail from source.
40+
41+
You'll need the [go programming language](https://golang.org/) installed and configured on your machine, and `$GOPATH/bin`
42+
added to your [PATH](https://superuser.com/questions/284342/what-are-path-and-other-environment-variables-and-how-can-i-set-or-use-them) for
43+
the following to work correctly.
3244

3345
Sail uses go modules to build the project, so the easiest way to install it to your system is to clone it in a directory
3446
outside of your `GOPATH`.
@@ -42,7 +54,7 @@ go install
4254
```
4355

4456

45-
### Verifying the Installation
57+
## Verifying the Installation
4658

4759
To verify Sail is properly installed, run `sail --help` on your system. If everything is installed
4860
properly, you should see Sail's help text.

0 commit comments

Comments
 (0)