forked from LaconicNetwork/kompose
Merge pull request #921 from dockerq/optimize/details-for-build
provide more details for building steps
This commit is contained in:
commit
ddd621a63e
26
README.md
26
README.md
@ -95,27 +95,27 @@ 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.
|
1. Clone repository
|
||||||
- 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:
|
```
|
||||||
|
2. Build with `make`
|
||||||
```console
|
```console
|
||||||
$ make bin
|
$ make bin
|
||||||
```
|
```
|
||||||
|
3. Or build with `go`
|
||||||
Or `go build`:
|
|
||||||
|
|
||||||
```console
|
```console
|
||||||
$ go build -o kompose main.go
|
$ go build -o kompose main.go
|
||||||
```
|
```
|
||||||
|
4. Test your changes
|
||||||
To create a multi-platform binary, use the `cross` command via `make`:
|
|
||||||
|
|
||||||
```console
|
```console
|
||||||
$ make cross
|
$ make test
|
||||||
```
|
```
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|||||||
@ -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
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user