search

google / git-appraise

Distributed code review system for Git repos
Apache License 2.0
5.13k stars 146 forks source link

Add manpage #75

Open stephengroat opened 7 years ago

stephengroat commented 7 years ago

it would be nice to have a manpage (maybe just including some of the current docs) that can show up in git help appraise

ojarjur commented 6 years ago

I agree that would be a big benefit.

kwstannard commented 6 years ago

I really want to try using this, but without a help prompt for each command there is no way I can justify spending time looking into how to integrate it to my workflow.

ojarjur commented 6 years ago

@kwstannard FYI, there is help text for each command, it's just not packaged as a man page.

To get help for an individual command, run git appraise help <COMMAND>, and to list the commands run git appraise help.

I know this doesn't support running git help appraise, as that will try to find the man page for "git-appraise", but there is documentation.

kwstannard commented 6 years ago

Is there a reason the project can't have the git appraise help output be the man page?

ojarjur commented 6 years ago

@kwstannard We could generate a man page, but I'm not aware of any way to have go get ... install it.

kwstannard commented 6 years ago

There probably isn't a way. Maybe with a different installation methodology you could do something like this: https://github.com/git-lfs/git-lfs/search?utf8=✓&q=man&type=