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.

Sign up for GitHub

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

Jump to bottom

Add man page to crystal #2147

Closed
wants to merge 4 commits into from
Closed

Add man page to crystal #2147

wants to merge 4 commits into from

Conversation

werner
Copy link
Contributor

@werner werner commented Feb 12, 2016

No description provided.

@asterite
Copy link
Member

I know nothing about man pages, so if somebody else can approve this, go ahead :-)

I guess if we accept this we should also add this somewhere in the installation process so that it's available, right?

@ysbaddaden
Copy link
Contributor

Just run man ./crystal.1 to see how it renders. Of course having the omnibus packager to install the man file in a man folder would be nice.

ysbaddaden
ysbaddaden reviewed Feb 18, 2016
View reviewed changes
man/crystal.1
The official web site.
.It https://github.com/manastech/crystal
Official Repository.
.Sh Contributing
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can skip "contributing" in the man page. Let's just stick to explain the command.

@ysbaddaden
Copy link
Contributor

Good job overall. Some more comments, about the design:

  • The indentation is large in a terminal (it quickly goes up to 30 chars). It would be nice to be closer to 8, to match the Linux man pages.
  • Maybe differentiate commands from options: first having a flat list of all commands (without options), then each command and their options? I'm not sure, thought, and open to suggestions :-)

@EvanHahn EvanHahn mentioned this pull request Apr 10, 2016
Closed
@miketheman
Copy link
Contributor

Very cool!

Is the intent for the man page to cover all crystal CLI commands? If so, then the addition of play and others might be needed.

do-you-dare pushed a commit to do-you-dare/crystal that referenced this pull request Jul 13, 2016
@werner
add man page to crystal
8628927 
Remove contributig section: crystal-lang#2147 (comment)

Include compiling instructions as stated in the docs.
crystal-lang#2147 (comment)

Fix indentation to 8 chars
@miketheman
Copy link
Contributor

Superseded by #2989, recommend closing this one.

do-you-dare pushed a commit to do-you-dare/crystal that referenced this pull request Oct 18, 2016
@werner
add man page to crystal
97f867d 
Remove contributig section: crystal-lang#2147 (comment)

Include compiling instructions as stated in the docs.
crystal-lang#2147 (comment)

Fix indentation to 8 chars
@matiasgarciaisaia
Copy link
Member

Closing in favour of #2989 - thanks @miketheman for kickstarting 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
kind:docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@werner @asterite @ysbaddaden @miketheman @matiasgarciaisaia