Readme text cleanup - Githubissues

OpenTTD / OpenMSX

Music Base Set for OpenTTD

GNU General Public License v2.0

22 stars 12 forks source link

Readme text cleanup #21

Open Wuzzy2 opened 3 years ago

Wuzzy2 commented 3 years ago

This PR just clean up some stuff in the readme files:

Fix outdated/incorrect references to other help resources
Remove the 'how to apply' section in the license (this part does not belong to the license, so it can be safely removed)
Shorten line length to 76 to get rid of the horizonal scrollbar in OpenTTD

I recommend to review per-commit.

TrueBrain commented 3 years ago

* Shorten line length to 76 to get rid of the horizonal scrollbar in OpenTTD

This strongly depends on font-face and font-size. I would really not optimize to this, as this will be a ping/pong between different people with different settings. Just my 2 cents here.

Wuzzy2 commented 3 years ago

Since we have the GitHub identifiers now, I see no reason not to reference them, though I don't think we did in OpenSFX. (We do in OpenTTD itself.)

We have no GitHub issue number 1210. ;-) These numbers come from openttdcoop, so they no longer make sense, unless we explicitly mention that this is an openttdcoop bug number (which might be overkill if you ask me).

This is part of the licence text, it should remain in place.

Did you even read it? It literally says "END OF TERMS AND CONDITONS" above. This section is clearly addressed to the licensor, i.e. us. For the licensee, i.e. the user, this section is irrelevant.

Wuzzy2 commented 3 years ago

This strongly depends on font-face and font-size. I would really not optimize to this, as this will be a ping/pong between different people with different settings. Just my 2 cents here.

76 should be a safe line length for most font sizes tho. Many lines were overlong.

This is about making the text readable without ugly horizontal scrollbar under DEFAULT settings and window size.

orudge commented 3 years ago

We have no GitHub issue number 1210. ;-) These numbers come from openttdcoop, so they no longer make sense, unless we explicitly mention that this is an openttdcoop bug number (which might be overkill if you ask me).

Ah, d'oh. OK, no real objection then.

Did you even read it? It literally says "END OF TERMS AND CONDITONS" above. This section is clearly addressed to the licensor, i.e. us. For the licensee, i.e. the user, this section is irrelevant.

Yes, I did read it, but the point is still that I think I pretty much have always seen the GPL quoted in its entirety, including "how to apply to new programs", and I don't think we should be cutting that bit out.

Wuzzy2 commented 3 years ago

The license commit was dropped.