Update docs #70
Update docs #70
Conversation
Makefile
Outdated
| @echo " scratch: Quick scratch build of RPM" | ||
| @echo " clean: Remove all built binaries" | ||
| @echo " lint: Run all known linters" | ||
| @awk 'match($$0, /^([a-zA-Z_\/-]+):.*? ## (.*)$$/, m) {printf " \033[36m%-30s\033[0m %s\n", m[1], m[2]}' $(MAKEFILE_LIST) | sort |
There was a problem hiding this comment.
What does this do? Print a sorted list of targets, I think?
Btw, this commit message seems to be incomplete:
Makefile: update help and improve
There was a problem hiding this comment.
actually not really, "improve…it"? :-D
I can rephrase
There was a problem hiding this comment.
Yes, just prints the help from the comments - is used in many other repos to have the comment next to the target and the help always up to date ;)
There was a problem hiding this comment.
actually not really, "improve…it"? :-D I can rephrase
in that case "Update and improve help" would be better.
There was a problem hiding this comment.
I'll wait for the general feedback which tags we use and how to unify them. Then I'll update the whole PR or maybe recreate it… a lot could change
README.md
Outdated
|
|
||
| ## Prerequisites | ||
|
|
||
| Make sure to have the required `osbuild` RPMs installed: | ||
| Make sure to have the required `osbuild` and dependent RPMs installed: |
There was a problem hiding this comment.
Maybe a bit nitpicky, but I'm not sure calling it a "dependent RPM" is accurate here.
gpgme-devel is a dependency of image-builder-cli (via imports). It's not a dependent of osbuild or image-builder-cli (i.e. gpgme-devel does not depend on osbuild or image-builder-cli).
There was a problem hiding this comment.
Yeah, it seems to fit better under the "Complication" section as it is just a build-dependency, if one installs the rpm from copr this should not needed
README.md
Outdated
|
|
||
| ## Prerequisites | ||
|
|
||
| Make sure to have the required `osbuild` RPMs installed: | ||
| Make sure to have the required `osbuild` and dependent RPMs installed: |
There was a problem hiding this comment.
Yeah, it seems to fit better under the "Complication" section as it is just a build-dependency, if one installs the rpm from copr this should not needed
README.md
Outdated
| @@ -32,12 +32,19 @@ $ go install github.com/osbuild/image-builder-cli/cmd/image-builder@main | |||
|
|
|||
| We plan to provide rpm packages in fedora as well. | |||
|
|
|||
| ## Compilation | |||
|
|
|||
| You can as well compile the application from local source with | |||
There was a problem hiding this comment.
Its probably good to add comething like You can compile the application in cmd/image-builder with the normal go commandd (or spell out the commands). Just to avoid the impression that there is anything special needed that requires a makefile (those are very usual IME in go projects)
There was a problem hiding this comment.
I tend to document copy'n'paste ready commands and with the make command we can adapt it and do other related things like create a bin directory (uh which should be added to .gitignore, I just saw) and also test it with all the tags needed to build (with github actions)
There was a problem hiding this comment.
Sure, but please also mention something like "You can compile the application in cmd/image-builder with the normal go command" just to avoid the impression that there is anything special needed that requires a makefile (those are very usual IME in go projects).
|
@mvo5 I just found that there are multiple build commands scattered around, one which is in the |
37e7a45 to
16c3cb4
Compare
16c3cb4 to
12471b7
Compare
12471b7 to
5fcbe02
Compare
As a dependency of `images` we also need `gpgme-devel` here, if we compile without `containers_image_openpgp`.
5fcbe02 to
90f2919
Compare
Followup of #68
without
gpgme-develneithergo run github.com/osbuild/image-builder-cli/cmd/image-builder@main(from theREADME.md)nor
make buildwork
(which essentially do the same)
So installing
gpgme-develmakes sense, I guess, which is also documented in images and we include that here.