Skip to content

Commit 5d307fc

Browse files
committed
Expand README
1 parent ec9df60 commit 5d307fc

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,21 @@ See examples/skipfile.yaml.
2727
2. Set GOPATH. See https://github.com/golang/go/wiki/SettingGOPATH.
2828
3. Install go dependencies. `go get ./...`
2929
4. go build
30-
5. ./skipgen
30+
5. `./skipgen`
3131

3232
## Development
3333

34+
Print usage:
3435
`$ go run skipgen.go`
36+
37+
Get default skiplist:
3538
`$ go run skipgen.go -skipfile examples/skipfile.yaml`
39+
40+
Get board and environment-specific skiplist:
3641
`$ go run skipgen.go -skipfile examples/skipfile.yaml -board x15 -environment production`
3742

3843
## Testing
3944

40-
`make test`
41-
45+
skipgen includes unit tests that can be run using `go test`. The `make test`
46+
target will also run 'go vet' and 'golint'. golint may need to be installed
47+
(`go get -u github.com/golang/lint/golint`)

0 commit comments

Comments
 (0)