Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): updated README and site to include installation using go install command #499

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,27 @@ and Mage automatically uses them as Makefile-like runnable targets.
Mage has no dependencies outside the Go standard library, and builds with Go 1.7
and above (possibly even lower versions, but they're not regularly tested).

**Using GOPATH**
**Using GOPATH with go version < 1.17**

```
go get -u -d github.com/magefile/mage
cd $GOPATH/src/github.com/magefile/mage
go run bootstrap.go
```

**Using Go Install with go version >= 1.18**

```
go install github.com/magefile/mage@latest
mage -init
```

Instead of the @latest tag, you can specify the desired version, for example:

```
go install github.com/magefile/[email protected]
```

**Using Go Modules**

```
Expand Down
14 changes: 13 additions & 1 deletion site/content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,26 @@ and Mage automatically uses them as Makefile-like runnable targets.
Mage has no dependencies outside the Go standard library, and builds with Go 1.7
and above (possibly even lower versions, but they're not regularly tested).

#### Using Go Modules (Recommended)
#### Using Go Modules (With go version < 1.17)

```plain
git clone https://github.com/magefile/mage
cd mage
go run bootstrap.go
```

#### Using Go Install (With go version >= [1.17](https://go.dev/doc/go-get-install-deprecation))

```plain
go install github.com/magefile/mage@latest
mage -init
```
Instead of the @latest tag, you can specify the desired version, for example:

```plain
go install github.com/magefile/[email protected]
```

#### Using GOPATH

```plain
Expand Down
Loading