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.

Sign up for GitHub

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

Jump to bottom

README: Punt detailed command description to the man pages #47

Merged
merged 2 commits into from
Apr 28, 2016
Merged

README: Punt detailed command description to the man pages #47

merged 2 commits into from
Apr 28, 2016

Commits on Apr 28, 2016

  1. README: Punt detailed command description to the man pages 

    This makes it easier to get a project overview from the README, and
avoids the tedium of keeping parallel sets of detailed docs up to
date.

Signed-off-by: W. Trevor King <wking@tremily.us>
    @wking
    wking committed Apr 28, 2016
    Configuration menu
    Copy the full SHA
    ba4a9a0 View commit details
    Browse the repository at this point in the history

  2. man/ocitools-generate.1: Copy-edits for the description 

    Also adjust the copy of this text in the README.

I've left the reference-style links out of the man page, since
go-md2man doesn't seem to be able to handle them, and instead creates
troff with just the link targets:

  \[la]man/ocitools-generate.1.md\[ra] generates a
  \[la]https://github.com/opencontainers/runtime-spec/blob/master/config.md\[ra] for an
  ...

Signed-off-by: W. Trevor King <wking@tremily.us>
    @wking
    wking committed Apr 28, 2016
    Configuration menu
    Copy the full SHA
    bb11739 View commit details
    Browse the repository at this point in the history