Add man page to crystal #2989
Add man page to crystal #2989
Conversation
| Show version. | ||
| .El | ||
| .Sh SEE ALSO | ||
| .Bl -hang -compact -width "https://github.com/manastech/crystal/1234" |
There was a problem hiding this comment.
Outdated URLs Also not sure what's this about
|
I've made a bunch of changes. Is there something more you would like to see here? |
| @@ -0,0 +1,230 @@ | |||
| .\"Crystal Programming Language | |||
| .Dd March 7, 2016 | |||
|
... and so on. That would be the minimum level of verbosity I would expect from a manpage, to have a benefit over |
| .El | ||
| .Sh SEE ALSO | ||
| .Fn shards 1 | ||
| .Bl -hang -compact -width "https://github.com/crystal-lang/crystal/1234" |
There was a problem hiding this comment.
This line appears to have no purpose as it does not display, and the link goes nowhere.
There was a problem hiding this comment.
The url really doesn't display; it is the argument for width. The url itself is not important, just its length. I can change this, if you want.
The line itself has purpose; it starts a block with .Bl with the same width as the dummy url.
Remove contributig section: crystal-lang#2147 (comment) Include compiling instructions as stated in the docs. crystal-lang#2147 (comment) Fix indentation to 8 chars
Signed-off-by: Eduardo Silva Araújo <[email protected]>
Signed-off-by: Eduardo Silva Araújo <[email protected]>
|
Any progress here, @jhass? |
|
Perhaps we can merge this so we have a man page for others to fix up and contribute to instead of being forever stalled. |
|
Thank you @dread-uo and everyone who reviewed! It took us a bit long, but here we are :). |
@werner started this, I'm starting from where he left. Any comments are welcome.
Closes #1291.