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

Updates documentation to reference mage build instead of go run make.go #48

Merged
merged 1 commit into from
Oct 12, 2017
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
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,16 @@ git clone git@github.com:gnormal/gnorm.git
cd gnorm
```

Afer this, you need to make sure that the dep tool is installed, and `$GOPATH/bin` is in your system `PATH`. Proceed to run the following commands
After this, you need to make sure that the [dep](https://github.com/golang/dep) tool is installed, and `$GOPATH/bin` is in your system `PATH`. Once complete, proceed to run the following commands:

```shell
dep ensure
```

Build the binary just to be sure everything is working
Next, make sure that [mage](https://github.com/magefile/mage) is installed. Mage will help you build the binary and ensure everything is working:

```
go run make.go
mage build
```

Running `gnorm` command should give you something like this, then you are all set up and good to `go`.
Expand Down
2 changes: 1 addition & 1 deletion cli/docs_make.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import (
)

func showDocs(env environ.Values, cmd *cobra.Command, args []string) error {
// this folder gets briefly copied here during go run make.go
// this folder gets briefly copied here during mage build
statikFS, err := fs.New()
if err != nil {
log.Fatal(err)
Expand Down
2 changes: 1 addition & 1 deletion cli/docs_nomake.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
)

func showDocs(env environ.Values, cmd *cobra.Command, args []string) error {
fmt.Fprintln(env.Stdout, "docs not available, you need to build with go run make.go")
fmt.Fprintln(env.Stdout, "docs not available, you need to build with mage build")

return nil
}
5 changes: 2 additions & 3 deletions site/content/getting-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,8 @@ and all major platforms are supported.

If you have a Go programming environment set up, you can `go get
gnorm.org/gnorm`. Note that if you install this way, `gnorm version` will not
output any build info. If you'd like the build info to be correct, run `go run
$GOPATH/src/gnorm.org/gnorm/make.go` which will compile the binary with the
current git information.
output any build info. If you'd like the build info to be correct, run `mage build`,
which will compile the binary with the current git information.

## Set up your config

Expand Down