Wrong build instructions in README

[hferentschik]

From the README:

For ordinary use, go build ./... is sufficient.

When developing this library, please use make to take advantage of the tests and validation.

That is not quite correct, if you check out the source, you will first need to run make vendor before being able to run go build.

On this note I am wondering why the actual go build is not integrated into the Makefile, depending on vendor. In fact, imo it should be the default target.

You should be able to checkout the sources and run make and everything gets bootstrapped and compiled.

[mtrmac]

Thanks for pointing this out, the instructions definitely need changing.

Though, it's not entirely obvious what is the right thing to say in there: containers/image is a library-only package, so building it separately does not give the user anything immediately useful, whatever the build instructions are. Adding a default make target AFAICT does not change this.

We could provide some instructions for integrating the library into a caller.

Or we could just point at skopeo and tell users to try building that instead to have something to experiment with.

I guess, preferably, both?

[hferentschik]

so building it separately does not give the user anything immediately useful,

Sure, but what's about development? Would it not make sense for development purposes to have the build part of the Makefile.

Consumers will indeed not see any of this.

[mtrmac]

Sure, but what's about development? Would it not make sense for development purposes to have the build part of the Makefile.

For development, the current default (get all tools, run tests) broadly makes sense. Sure, adding a go build ./... step in there to catch subpackages with no tests would be great; I currently use go build ./... && make as my primary compile/test step, and folding that into a simple make would be better.