Add build instructions to README.md #1156
Conversation
Frostman
left a comment
Frostman
left a comment
There was a problem hiding this comment.
Hello, thank you for your contribution! A few comments inline.
README.md
Outdated
| ``` | ||
| ### Build Steps | ||
|
|
||
| 1. **Install build tools** |
There was a problem hiding this comment.
It's not required to manually run it, missing tools will be installed automatically
README.md
Outdated
| - `crd-ref-docs` - CRD documentation generator | ||
| - And other supporting tools | ||
|
|
||
| **Note:** If the tools are installed in `hack/bin/` instead of `bin/`, move them: |
There was a problem hiding this comment.
Hm, that's very strange, we're not seeing it on both dev machines and in CI. What version of just do you have? AFAIR at least 1.36 is required, so we should rather document it as a requirement other then providing the workaround.
There was a problem hiding this comment.
Looks like yes, 1.36.0 works as you described. I have updated the instructions, thanks for the pointer!
README.md
Outdated
| just kube-build | ||
| ``` | ||
|
|
||
| **Known Issue**: Due to a working directory issue in the justfile, `just kube-build` may fail with `cp: cannot stat 'bin/fabric'`. If this happens, manually copy the binaries and build the Docker images: |
There was a problem hiding this comment.
That's strange as well, probably the same issue as in the previous comment.
Signed-off-by: Galo Navarro <anglorvaroa@gmail.com>
Signed-off-by: Galo Navarro <anglorvaroa@gmail.com>
2 participants
No description provided.