Merge pull request #921 from dockerq/optimize/details-for-build

provide more details for building steps
This commit is contained in:
Charlie Drage 2018-02-07 08:00:32 -05:00 committed by GitHub
commit ddd621a63e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 14 deletions

View File

@ -95,27 +95,27 @@ Download from [Bintray](https://dl.bintray.com/kompose/kompose/latest/kompose-wi
### Building with `go`
__Requisites:__
1. [make](https://www.gnu.org/software/make/)
2. [Golang](https://golang.org/) v1.6 or later
3. Set `GOPATH` correctly or click [SettingGOPATH](https://github.com/golang/go/wiki/SettingGOPATH) for details
- You need `make`
- You need `go` v1.6 or later.
- If your working copy is not in your `GOPATH`, you need to set it accordingly.
You can either build via the Makefile:
__Steps:__
1. Clone repository
```console
$ git clone https://github.com/kubernetes/kompose.git $GOPATH/src/github.com/kubernetes/kompose
```
2. Build with `make`
```console
$ make bin
```
Or `go build`:
3. Or build with `go`
```console
$ go build -o kompose main.go
```
To create a multi-platform binary, use the `cross` command via `make`:
4. Test your changes
```console
$ make cross
$ make test
```
## Documentation

View File

@ -34,7 +34,7 @@ Will load the shell completion code.
},
}
// Generate the approriate autocompletion file
// Generate the appropriate autocompletion file
func Generate(cmd *cobra.Command, args []string) error {
// Check the passed in arguments