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

Add man page #55

Closed
wants to merge 1 commit into from
Closed

Add man page #55

wants to merge 1 commit into from

Conversation

R1kaB3rN
Copy link
Member

@R1kaB3rN R1kaB3rN commented Mar 7, 2024

Adds a simple man page to the project that contains some example usages for users, which avoids the need to refer to the Github page for concrete examples. Targeted for system package installations, and for users who use ULWGL directly from the CLI instead from a client application.

The man page will be generated by scdoc and expected to be automatically built at build time.

- Add a simple man page (roff) to be generated by scdoc that contains example usages for users. Avoids the need to refer to the Github page for concrete examples, and is mostly relevant to users who decide to use ULWGL directly from the CLI instead from a client application.
@R1kaB3rN R1kaB3rN added the documentation Improvements or additions to documentation label Mar 7, 2024
@R1kaB3rN R1kaB3rN closed this Mar 7, 2024
@R1kaB3rN R1kaB3rN deleted the docs branch March 7, 2024 23:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant