opencontainers / image-tools

OCI Image Tooling

https://opencontainers.org

Apache License 2.0

271 stars 82 forks source link

ReadMe should include description of how to install #91

Closed RobDolinMS closed 7 years ago

RobDolinMS commented 7 years ago

The ReadMe should include a description (or link to a description) for how to install and run the OCI Image Tools.

RobDolinMS commented 7 years ago

Opening per discussion on OCI Dev ConCall. /cc @vbatts

Sn0rt commented 7 years ago

Can I copy some examples from the existing markdown to ReadMe?

oci-create-runtime-bundle oci-image-validate oci-unpack

wking commented 7 years ago

On Thu, Dec 01, 2016 at 01:34:08AM -0800, Sn0rt wrote:

Can I copy some examples from the existing markdown to ReadMe?

I'd rather link to those man pages to stay DRY, although very brief examples being copied over are ok (like runtime-tools did in opencontainers/runtime-tools#47). Another approach to this portion of getting-started is an all-command man page (linked from the README) like the one I floated in #5 1.

92 looks useful too.

JJ commented 7 years ago

Definitely something should be done, either way

wking commented 7 years ago

On Wed, Dec 21, 2016 at 11:24:32AM -0800, Juan Julián Merelo Guervós wrote:

Definitely something should be done, either way

I think #92 covers everything folks want from this issue.

JJ commented 7 years ago

It might, when it's closed. Thanks for pointing it out, anyway.

wking commented 7 years ago

Closable with #92 landed?