-
Notifications
You must be signed in to change notification settings - Fork 771
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.
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
provide more details for building steps #921
Conversation
alwqx
commented
Feb 1, 2018
- add more detailed steps for building code
- fix typo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a few changes, otherwise LGTM
README.md
Outdated
You can either build via the Makefile: | ||
|
||
__Steps:__ | ||
- clone code |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change to: 1. Clone repository
README.md
Outdated
```console | ||
$ git clone https://github.com/kubernetes/kompose.git $GOPATH/src/github.com/kubernetes/kompose | ||
``` | ||
- build by make |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change to: 2. Build with make
README.md
Outdated
|
||
Or `go build`: | ||
|
||
- build by go |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change to: Or build with go
README.md
Outdated
```console | ||
$ make cross | ||
``` | ||
- do not forget test |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change to Test your changes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK
README.md
Outdated
|
||
To create a multi-platform binary, use the `cross` command via `make`: | ||
|
||
- create a multi-platform binary |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be removed as we already explain how to create a multi-platform binary :)
@cdrage Has update |
Thank you for your contribution, this LGTM! 👍 |