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

[RDY] Add man page for corsix-th #1446

Merged
merged 1 commit into from Sep 20, 2018

Conversation

Projects
None yet
2 participants
@TheCycoONE
Copy link
Member

TheCycoONE commented Aug 23, 2018

New man page inspired by the one included in Debian. This one is written in mdoc; which has the advantage of being a largely semantic markup producing consistent man pages.

I plan to sort the resource files dumped into /CorsixTH in the future; at present this seems like it belongs; which allows me to put it in the CorsixTH CMake file, and likewise add a man page for e.g. AnimView that is only installed when AnimView is included in the build.

I do plan to add the install to cmake as part of this PR. I will likely also add a files section similar to what Debian has.

@TheCycoONE TheCycoONE force-pushed the TheCycoONE:man2 branch from 794a5f3 to 8e3c00e Sep 11, 2018

@TheCycoONE TheCycoONE changed the title [WIP | RFC] Add man page for corsix-th [RDY] Add man page for corsix-th Sep 11, 2018

@TheCycoONE TheCycoONE changed the title [RDY] Add man page for corsix-th [WIP] Add man page for corsix-th Sep 11, 2018

@TheCycoONE TheCycoONE changed the title [WIP] Add man page for corsix-th [RDY] Add man page for corsix-th Sep 11, 2018

@TheCycoONE TheCycoONE changed the title [RDY] Add man page for corsix-th [RFC] Add man page for corsix-th Sep 11, 2018

@TheCycoONE

This comment has been minimized.

Copy link
Member

TheCycoONE commented Sep 11, 2018

Need to exclude Apple

.Nd "An" open source implementation "of" Theme Hospital
.Sh SYNOPSIS
.Nm
.Op Fl -bitmap-dir Ns Ar =path

This comment has been minimized.

@Alberth289346

Alberth289346 Sep 11, 2018

Contributor

Is it intentional that the = is concatenated with path here? other options do it differently, not to mention line 44

This comment has been minimized.

@TheCycoONE

TheCycoONE Sep 11, 2018

Member

No, I'll fix this.

.Sh DESCRIPTION
CorsixTH is a reimplementation of the 1997 Bullfrog business simulation game Theme Hospital.
As well as faithfully recreating the original, CorsixTH adds support for modern operating systems, high resolution displays, and much more.
A purchased copy of Theme Hospital, or the Theme Hospital demo is required to use CorsixTH.

This comment has been minimized.

@Alberth289346

Alberth289346 Sep 11, 2018

Contributor

Isn't the demo useful for only a few levels? It now looks asif it's a full alternative for the purchased copy.
Would be fair to warn about that, I think.

This comment has been minimized.

@TheCycoONE

TheCycoONE Sep 11, 2018

Member

I copied this text, with minor editing, from http://corsixth.com/

Screenshot directory.
.El
.Sh COPYRIGHT
.Lk https://raw.githubusercontent.com/CorsixTH/CorsixTH/master/LICENSE.txt

This comment has been minimized.

@Alberth289346

Alberth289346 Sep 11, 2018

Contributor

Maybe mention the name of the license as well, for those without Internet while reading the man page?

@Alberth289346

This comment has been minimized.

Copy link
Contributor

Alberth289346 commented Sep 11, 2018

Just minor stuff, looking great, nice job

@TheCycoONE

This comment has been minimized.

Copy link
Member

TheCycoONE commented Sep 12, 2018

Updated to hopefully address your concerns and mine.

Add man page for corsix-th
New man page inspired by the one included in Debian.

Add man page to unix install

@TheCycoONE TheCycoONE force-pushed the TheCycoONE:man2 branch from 7bc4f9f to 909bf3c Sep 20, 2018

@TheCycoONE TheCycoONE changed the title [RFC] Add man page for corsix-th [RDY] Add man page for corsix-th Sep 20, 2018

@TheCycoONE

This comment has been minimized.

Copy link
Member

TheCycoONE commented Sep 20, 2018

Ready to merge

@Alberth289346 Alberth289346 merged commit 553adf3 into CorsixTH:master Sep 20, 2018

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment