search

foriequal0 / git-trim

Automatically trims your branches whose tracking remote refs are merged or stray
MIT License
492 stars 14 forks source link

Create a man page #40

Closed majecty closed 4 years ago

majecty commented 4 years ago

Man page is a standard way to find a tool's usage. Git shows a man page if user execute git <subcommand> --help.

Unfortunately, we can't install the man page when a user uses cargo install git-trim command. If we provide a deb or rpm package file, however, we can distribute the man page with a binary.

majecty commented 4 years ago

@foriequal0 Can I try this issue?

foriequal0 commented 4 years ago

Okay. I've assigned to you.

majecty commented 4 years ago

I checked the ripgrep repository. They are generating man pages in the "cargo build" command. I'll follow their method.

majecty commented 4 years ago

The ripgrep team is using asciidoc to generate the man page. I'm checking the asciidoc.

majecty commented 4 years ago

I found that we can use markdown to generate man pages: link. Since markdown is much easier syntax, I'll try it.

foriequal0 commented 4 years ago

Closed by https://github.com/foriequal0/git-trim/pull/50