Skip to content

Commit

Permalink
chore(docs): updated README and site to include installation using go…
Browse files Browse the repository at this point in the history
… install command (#499)

* chore(docs): updated README and site index with installation guide
  • Loading branch information
egor-denysenko authored Nov 26, 2024
1 parent 32e0107 commit bdc92f6
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 2 deletions.
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/mage@v1.15.0
```

**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/mage@v1.15.0
```

#### Using GOPATH

```plain
Expand Down

0 comments on commit bdc92f6

Please sign in to comment.