Skip to content
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

Merged
merged 2 commits into from
Feb 7, 2018
Merged

provide more details for building steps #921

merged 2 commits into from
Feb 7, 2018

Conversation

alwqx
Copy link
Contributor

@alwqx alwqx commented Feb 1, 2018

  1. add more detailed steps for building code
  2. fix typo

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 1, 2018
Copy link
Member

@cdrage cdrage left a 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
Copy link
Member

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
Copy link
Member

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
Copy link
Member

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
Copy link
Member

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

Copy link
Contributor Author

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
Copy link
Member

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 :)

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 7, 2018
@alwqx
Copy link
Contributor Author

alwqx commented Feb 7, 2018

@cdrage Has update

@cdrage
Copy link
Member

cdrage commented Feb 7, 2018

Thank you for your contribution, this LGTM! 👍

@cdrage cdrage merged commit ddd621a into kubernetes:master Feb 7, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants