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.

Sign up for GitHub

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

Recommend Go Modules in the README #1011

Merged
merged 2 commits into from
Dec 24, 2019
Merged

Recommend Go Modules in the README #1011

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd803d3
Update README.md
coilysiren Dec 24, 2019
0757e0c
Merge branch 'master' into lynncyrin-patch-9
coilysiren Dec 24, 2019
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
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ Usage documentation exists for each major version. Don't know what version you'r
- `v2` - [./docs/v2/manual.md](./docs/v2/manual.md)
- `v1` - [./docs/v1/manual.md](./docs/v1/manual.md)

## Installation

Make sure you have a working Go environment. Go version 1.11+ is supported. [See the install instructions for Go](http://golang.org/doc/install.html).

Go Modules are strongly recommended when using this package. [See the go blog guide on using Go Modules](https://blog.golang.org/using-go-modules).

### Using `v2` releases

```
Expand All @@ -36,7 +42,7 @@ import (
### Using `v1` releases

```
$ go get github.com/urfave/cli
$ GO111MODULE=on go get github.com/urfave/cli
```

```go
Expand All @@ -47,11 +53,6 @@ import (
...
```

## Installation

Make sure you have a working Go environment. Go version 1.10+ is supported. [See
the install instructions for Go](http://golang.org/doc/install.html).

### GOPATH

Make sure your `PATH` includes the `$GOPATH/bin` directory so your commands can
Expand Down