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

Manual page for lychee #1505

Open
thomas-zahner opened this issue Sep 22, 2024 · 1 comment
Open

Manual page for lychee #1505

thomas-zahner opened this issue Sep 22, 2024 · 1 comment
Labels
docs Improvements or additions to documentation

Comments

@thomas-zahner
Copy link
Member

As a user of lychee I'd like to read the manual with man lychee as is possible with other programs.

Personally, I've never written a man page before, but I can give it a shot when I find the time. Most content from the README can probably be reused. I guess the sections and structure would be the most difficult part to get right.

@mre do you have any experience with writing man pages?

@thomas-zahner thomas-zahner added the docs Improvements or additions to documentation label Sep 22, 2024
@mre
Copy link
Member

mre commented Sep 23, 2024

Good idea. I don't have any experience with man pages yet, but the README and the docs are a good start.

As for tooling, here's a survey: https://stackoverflow.com/a/78226570

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

No branches or pull requests

2 participants