-
-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Move godot-cpp custom API file information from "Getting Started" to build system information #11344
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
base: master
Are you sure you want to change the base?
Conversation
3fe02e7
to
b544f70
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! This looks great me :-)
…ructions from the intro doc, because most people won't need it for their first project.
b544f70
to
88604e5
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good 👍🏻
LGTM. Should we cherrypick this for any branches? |
It applies to 4.5. Can't cherry-pick further than that though because of previous changes. |
On Discord, we regularly get people asking about or being directed to the "Getting Started" section of godot-cpp. This is great, because that means it's really useful!
However, we also regularly get people building with custom api files, although they do not intend to target the latest
master
or a custom branch. Often, they end up doing it because they don't read the text carefully enough to realize that this step is optional.Since most people do not need to build custom api files, and will target a stable branch instead, I don't think this information should be part of the "Getting Started" doc. I therefore propose to move it to "Build system" in a dedicated subsection instead.