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.

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

Man pages #32

Open
Arteneko opened this issue Jan 11, 2020 · 2 comments
Open

Man pages #32

Arteneko opened this issue Jan 11, 2020 · 2 comments

Comments

@Arteneko
Copy link
Contributor

What do you think about including man pages with the tool / releases (or alongside the release binaries)?

I wrote some for a project for a linux tool, and I find it really useful to have the tool / configuration documentation right on my computer, in a format I can use in my terminal, on a centralized place.

@Keats
Copy link
Owner

Keats commented Jan 12, 2020

What would be in those man pages? It seems like it would be a copy of the README.

@Arteneko
Copy link
Contributor Author

Pretty much. Maybe an in-depth template documentation, too.

It's nice to be able to have a locally browsable documentation that can be found in the same place as other docs.

Some tools to convert Markdown to troff probably exists, too.

(darnit, github not taking my email replies into account, makes me forget about issues I failed to answer through email)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants