provide more details for building

This commit is contained in:
adolphlwq 2018-02-01 17:35:07 +08:00
parent c339ebcbf1
commit 678103831a
2 changed files with 17 additions and 13 deletions

View File

@ -95,28 +95,32 @@ Download from [Bintray](https://dl.bintray.com/kompose/kompose/latest/kompose-wi
### Building with `go` ### 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` __Steps:__
- You need `go` v1.6 or later. - clone code
- If your working copy is not in your `GOPATH`, you need to set it accordingly. ```console
$ git clone https://github.com/kubernetes/kompose.git $GOPATH/src/github.com/kubernetes/kompose
You can either build via the Makefile: ```
- build by make
```console ```console
$ make bin $ make bin
``` ```
- build by go
Or `go build`:
```console ```console
$ go build -o kompose main.go $ go build -o kompose main.go
``` ```
- create a multi-platform binary
To create a multi-platform binary, use the `cross` command via `make`:
```console ```console
$ make cross $ make cross
``` ```
- do not forget test
```console
$ make test
```
## Documentation ## 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 { func Generate(cmd *cobra.Command, args []string) error {
// Check the passed in arguments // Check the passed in arguments