Shards: Add man page

Created on 21 Dec 2017  路  5Comments  路  Source: crystal-lang/shards

suggested in crystal-lang/crystal-book#174

Most helpful comment

I believe that the package maintainer for Arch would've included the man pages if he knew they were there, since he already included them for the crystal package. I also did not assume that the man pages would be in src.

I have created a pull request to use a top-level man directory, just like Crystal itself. This should make it easier for package maintainers to know that these man pages exist.

All 5 comments

There are already. They may not be installed by distributiond, but there are.

Perhaps it should be moved out of the src folder. The src folder is usually for code.

That's why I didn't see it.

But the issue is not just about having a man page in the project repository, but to make it available to people who are using shards. How do we get it in the distribution packages?

@straight-shoota make it obvious or tell the distributors about it. Or provide a make install.

I believe that the package maintainer for Arch would've included the man pages if he knew they were there, since he already included them for the crystal package. I also did not assume that the man pages would be in src.

I have created a pull request to use a top-level man directory, just like Crystal itself. This should make it easier for package maintainers to know that these man pages exist.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

stakach picture stakach  路  4Comments

vladfaust picture vladfaust  路  7Comments

InstanceOfMichael picture InstanceOfMichael  路  5Comments

paulcsmith picture paulcsmith  路  8Comments

bcardiff picture bcardiff  路  8Comments