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

readme: Link man pages in root README #368

Merged
merged 2 commits into from
Nov 3, 2024

Conversation

ZirixCZ
Copy link
Contributor

@ZirixCZ ZirixCZ commented Oct 28, 2024

Mentioned here #367 (comment)

Currently it is possible to view the man pages either through installing them or by finding the correct file in the project. This PR links the man pages directly in the root README.

@joggee-fr
Copy link
Collaborator

joggee-fr commented Oct 28, 2024

I was thinking of a more explicit sentence in the "Building and running Cage" section. For example, "The available command line options and environment variables are listed in the dedicated man page.", something like that.

@ZirixCZ
Copy link
Contributor Author

ZirixCZ commented Oct 28, 2024

That is what I wanted to write. The man page doesn't only include command line arguments however. Though it might be good to put it right next to the guide on how to run cage after it's been built. Something like: You can run Cage by running ./build/cage APPLICATION. List of available command line options and environment variables is listed in the dedicated man page.

@emersion
Copy link
Contributor

emersion commented Nov 1, 2024

Or should it be in the first section, near the wiki and project page links? (Since it's useful for users installing from their distro package too instead of building from source)

@emersion emersion merged commit 0208f56 into cage-kiosk:master Nov 3, 2024
10 checks passed
@emersion
Copy link
Contributor

emersion commented Nov 3, 2024

Thanks!

@ZirixCZ ZirixCZ deleted the link-man-in-readme branch November 3, 2024 15:30
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

Successfully merging this pull request may close these issues.

3 participants