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

Docs: indicate where to find an excellent tutorial on using CMake #8475

Merged
merged 1 commit into from Jan 2, 2021

Conversation

@TrueBrain
Copy link
Member

@TrueBrain TrueBrain commented Jan 1, 2021

Fixes #8465

Motivation / Problem

As mentioned in #8465, we only mention how to produce a Debug build. We kinda assume people know CMake when starting to develop. This does not have to be the case.

Description

Instead of explaining all the ins and outs of basic CMake usage, reference their excellent tutorial which helps you through the basics in a few lines of text.

Limitations

  • We can delve into more detail how to do the basics ourself, but referencing external documentation might be more useful.

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')
@TrueBrain TrueBrain force-pushed the TrueBrain:docs_compiling branch from f2ee7d9 to 8c4b985 Jan 1, 2021
@TrueBrain TrueBrain force-pushed the TrueBrain:docs_compiling branch from 8c4b985 to ee48cbc Jan 1, 2021
@LordAro
LordAro approved these changes Jan 2, 2021
@TrueBrain TrueBrain merged commit 126f40e into OpenTTD:master Jan 2, 2021
8 checks passed
8 checks passed
Emscripten
Details
Commit checker
Details
Check preview needs update Check preview needs update
Details
Linux (clang, clang++)
Details
Linux (gcc, g++)
Details
Mac OS (x64, x86_64) Mac OS (x64, x86_64)
Details
Windows (x86) Windows (x86)
Details
Windows (x64) Windows (x64)
Details
@TrueBrain TrueBrain deleted the TrueBrain:docs_compiling branch Jan 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

2 participants