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 #24

Merged
merged 1 commit into from
Jan 10, 2018
Merged

Add man page #24

merged 1 commit into from
Jan 10, 2018

Conversation

wezm
Copy link
Contributor

@wezm wezm commented Jan 10, 2018

This PR adds a man page. It uses a trick that ripgrep uses to convert a Markdown file into man page for easier writing and maintenance.

Here's what it looks like rendered:

rendered fac man page

@mkchoi212
Copy link
Owner

This is awesome! Regarding the installation of the man page, is there a simple script we could whip up? Or do we usually just leave the installation to the user?

@wezm
Copy link
Contributor Author

wezm commented Jan 10, 2018

That's probably up to package maintainers. I added fac to the Arch User Repository and have a spot in the PKGBUILD script waiting for the man page :-)

@mkchoi212
Copy link
Owner

That's awesome! Thank you 👍

@mkchoi212 mkchoi212 merged commit 8f11fd7 into mkchoi212:master Jan 10, 2018
@mkchoi212
Copy link
Owner

@wezm Any updates?? I don't really know how to make sense of the website you linked to :p

@wezm
Copy link
Contributor Author

wezm commented May 17, 2018

I still think it's the concern of people packaging fac for their platforms. For example in the PKGBUILD file linked above, which describes how to build a package on Arch Linux I include the man page in the package. Similarly in the homebrew formula the formula would install the man page as part of the homebrew package. For example this line in the ripgrep formula: https://github.com/Homebrew/homebrew-core/blob/0ed3f5b8925b2b202dacd64412414783557ff216/Formula/ripgrep.rb#L28

@mkchoi212
Copy link
Owner

Is there any I can do to fix it??

@wezm
Copy link
Contributor Author

wezm commented May 21, 2018

Is there any I can do to fix it??

Sorry, I'm not following. What do you think needs fixing?

@mkchoi212
Copy link
Owner

mkchoi212 commented May 21, 2018

I completely misunderstood what you meant by

I still think it's the concern of people packaging fac for their platforms.

Nevermind 😄

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.

2 participants