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

Update documentation for supported OSes, required libraries, and CMake options #9074

Merged
merged 4 commits into from Apr 21, 2021

Conversation

@TrueBrain
Copy link
Member

@TrueBrain TrueBrain commented Apr 21, 2021

Motivation / Problem

Docs were out of date. I am trying to fix them a bit.

Closes #9054 , as it is an alternative to it.
Fixes #8465 again. As I changed my opinion on the matter.

Description

Bit of a mixed bag, but:

  • We listed we officially supported some OSes I am pretty sure we haven't compiled in months / years. So lets drop the act. If they work on those OSes, great! If people want to make PRs for them: awesome! But .. "officially" supported is stretching it.
  • Libraries didn't indicate when they were useful. #9054 tried to address some of it, but it was outdated anyway. This should be more correct (I hope :D).
  • CMake options we created were not really documented, making it hard for someone to find them. Be a bit more upfront about them. #8465 already suggested this, but I was too blind to see this is useful.
  • Some links were pointing to redirects, instead of the final destination.

Limitations

Checklist for review

Some things are not automated, and forgotten often. This list is a reminder for the reviewers.

  • The bug fix is important enough to be backported? (label: 'backport requested')
  • This PR affects the save game format? (label 'savegame upgrade')
  • This PR affects the GS/AI API? (label 'needs review: Script API')
    • ai_changelog.hpp, gs_changelog.hpp need updating.
    • The compatibility wrappers (compat_*.nut) need updating.
  • This PR affects the NewGRF API? (label 'needs review: NewGRF')
COMPILING.md Outdated Show resolved Hide resolved
@James103
Copy link
Contributor

@James103 James103 commented Apr 21, 2021

Closes #9045 , as it is an alternative to it.

Did you mean to use #9054 in lieu of #9045?

@TrueBrain
Copy link
Member Author

@TrueBrain TrueBrain commented Apr 21, 2021

Closes #9045 , as it is an alternative to it.

Did you mean to use #9054 in lieu of #9045?

I keep doing this wrong, am I not? You would think I have some braincells ... lol. Tnx!

@nielsmh
Copy link
Contributor

@nielsmh nielsmh commented Apr 21, 2021

I'd add a line after the "supported platforms" that

Other platforms may also work (in particular various BSD systems), but we don't actively test or maintain these.

@TrueBrain TrueBrain merged commit 96b78bc into OpenTTD:master Apr 21, 2021
12 checks passed
@TrueBrain TrueBrain deleted the fix-readme branch Apr 21, 2021
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.

5 participants