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.

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

Doc: revised README to be more helpful to casual GitHub visitors #7807

Merged
merged 1 commit into from Nov 13, 2019

Conversation

@andythenorth
Copy link
Contributor

andythenorth commented Oct 27, 2019

Think this is ready for nitpicking.

Note for reviewers: there's a lot of prior discussion about this on irc, anyone approaching it cold might find they're lacking the full tedious backstory

  • the goal is to make the readme more approachable and useful to GitHub casual visitors, without losing the ability to read it locally in the distributed bundle
  • this may also end being visible in-game via #7786 but that is a separate concern
  • we're comfortable linking to remote pages that require an internet connection

For minor typos, it would be helpful to just fix them and force push. Putting typo change requests on the GH PR review is pointless triple-handling for fixing minor typos. Thx!

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@andythenorth andythenorth force-pushed the andythenorth:revise-readme-october-2019 branch 10 times, most recently from 3ef1769 to 4da1ea0 Oct 28, 2019
@andythenorth andythenorth force-pushed the andythenorth:revise-readme-october-2019 branch 3 times, most recently from 24685e0 to f904bd0 Nov 9, 2019
Copy link
Member

michicc left a comment

👍

README.md Outdated Show resolved Hide resolved
@andythenorth andythenorth force-pushed the andythenorth:revise-readme-october-2019 branch from f904bd0 to 769499b Nov 9, 2019
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved

#### 4.1.1) Free graphics and sound files
### 1.4.1) Free graphics and sound files

The free data files, split into OpenGFX for graphics, OpenSFX for sounds and

This comment has been minimized.

Copy link
@LordAro

LordAro Nov 10, 2019

Member

Section might want a rework - very repetitive "Open*FX" and bare links

This comment has been minimized.

Copy link
@andythenorth

andythenorth Nov 10, 2019

Author Contributor

+1 but no ideas for solutions...

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved

Game scripts can provide additional challenges or changes to the standard OpenTTD gameplay, for example setting transport goals, or changing town growth behaviour.

Game scripts can be added via the 'Check Online Content' button in the main menu.

This comment has been minimized.

Copy link
@LordAro

LordAro Nov 10, 2019

Member

Very very repetitive "can be added via the ..." Put into parent section.

This comment has been minimized.

Copy link
@andythenorth

andythenorth Nov 10, 2019

Author Contributor

It is very repetitive, but the information under each sub-heading has to stand alone as instructions. Can't rely on referring up, or assuming the reader has read or retained earlier information.

I tried to think of a better way, but this was it so far.

README.md Outdated Show resolved Hide resolved
@andythenorth andythenorth force-pushed the andythenorth:revise-readme-october-2019 branch 7 times, most recently from 259c20b to aecb8d4 Nov 10, 2019
@andythenorth andythenorth force-pushed the andythenorth:revise-readme-october-2019 branch from aecb8d4 to 4787f0b Nov 10, 2019
@michicc michicc merged commit cfc4568 into OpenTTD:master Nov 13, 2019
8 checks passed
8 checks passed
OpenTTD CI Build #20191110.15 succeeded
Details
OpenTTD CI (Linux commit-checker) Linux commit-checker succeeded
Details
OpenTTD CI (Linux linux-amd64-clang-3.9) Linux linux-amd64-clang-3.9 succeeded
Details
OpenTTD CI (Linux linux-amd64-gcc-6) Linux linux-amd64-gcc-6 succeeded
Details
OpenTTD CI (Linux linux-i386-gcc-6) Linux linux-i386-gcc-6 succeeded
Details
OpenTTD CI (MacOS) MacOS succeeded
Details
OpenTTD CI (Windows Win32) Windows Win32 succeeded
Details
OpenTTD CI (Windows Win64) Windows Win64 succeeded
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants
You can’t perform that action at this time.