Skip to content

Commit e84bbc1

Browse files
mirogtanatefinch
andauthored
#288 add brew and scoop install to docs (#376)
Co-authored-by: Nate Finch <[email protected]>
1 parent 80953f7 commit e84bbc1

File tree

2 files changed

+26
-11
lines changed

2 files changed

+26
-11
lines changed

site/content/index.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,22 @@ title = "Mage"
77
Mage is a make/rake-like build tool using Go. You write plain-old go functions,
88
and Mage automatically uses them as Makefile-like runnable targets.
99

10-
1110
## Installation
1211

12+
### From GitHub source (any OS)
13+
1314
Mage has no dependencies outside the Go standard library, and builds with Go 1.7
14-
and above (possibly even lower versions, but they're not regularly tested).
15+
and above (possibly even lower versions, but they're not regularly tested).
1516

16-
**Using Go Modules (Recommended)**
17+
#### Using Go Modules (Recommended)
1718

1819
```plain
1920
git clone https://github.com/magefile/mage
2021
cd mage
2122
go run bootstrap.go
2223
```
2324

24-
**Using GOPATH**
25+
#### Using GOPATH
2526

2627
```plain
2728
go get -u -d github.com/magefile/mage
@@ -33,14 +34,28 @@ This will download the code into your GOPATH, and then run the bootstrap script
3334
to build mage with version infomation embedded in it. A normal `go get`
3435
(without -d) will build the binary correctly, but no version info will be
3536
embedded. If you've done this, no worries, just go to
36-
$GOPATH/src/github.com/magefile/mage and run `mage install` or `go run
37+
`$GOPATH/src/github.com/magefile/mage` and run `mage install` or `go run
3738
bootstrap.go` and a new binary will be created with the correct version
3839
information.
3940

4041
The mage binary will be created in your $GOPATH/bin directory.
4142

43+
### From GitHub releases (any OS)
44+
4245
You may also install a binary release from our
43-
[releases](https://github.com/magefile/mage/releases) page.
46+
[releases](https://github.com/magefile/mage/releases) page.
47+
48+
### With Homebrew (MacOS)
49+
50+
`brew install mage`
51+
52+
See [mage homebrew formula](https://formulae.brew.sh/formula/mage).
53+
54+
### With Scoop (Windows)
55+
56+
`scoop install mage`
57+
58+
See [scoop](https://scoop.sh/).
4459

4560
## Example Magefile
4661

@@ -72,14 +87,14 @@ Run the above `Build` target by simply running `mage build` in the same director
7287

7388
Join the `#mage` channel on [gophers slack](https://gophers.slack.com/messages/general/) for discussion of usage, development, etc.
7489

75-
7690
## Plugins
7791

7892
There are no plugins. You don't need plugins. It's just Go code. You can
7993
import whatever libraries you want. Every library in the go ecosystem is a mage
8094
plugin. Every tool you use with Go can be used with Magefiles.
8195

8296
## Usage
97+
8398
```plain
8499
mage [options] [target]
85100
@@ -101,7 +116,7 @@ Options:
101116
-f force recreation of compiled magefile
102117
-goarch sets the GOARCH for the binary created by -compile (default: current arch)
103118
-gocmd <string>
104-
use the given go binary to compile the output (default: "go")
119+
use the given go binary to compile the output (default: "go")
105120
-goos sets the GOOS for the binary created by -compile (default: current OS)
106121
-h show description of a target
107122
-keep keep intermediate mage files around after running
@@ -110,7 +125,7 @@ Options:
110125
-v show verbose output when running mage targets
111126
-w <string>
112127
working directory where magefiles will run (default -d value)
113-
```
128+
```
114129

115130
## Why?
116131

site/content/zeroInstall/_index.en.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ Now you can `go run mage.go <target>` and it'll work just as if you ran
2121
package main
2222

2323
import (
24-
"os"
25-
"github.com/magefile/mage/mage"
24+
"os"
25+
"github.com/magefile/mage/mage"
2626
)
2727

2828
func main() { os.Exit(mage.Main()) }

0 commit comments

Comments
 (0)