Skip to content

Enhance README usage instructions, and add links - #100

Merged
paddy-exe merged 1 commit into
godotengine:mainfrom
Ivorforce:usage-update
Nov 7, 2025
Merged

paddy-exe merged 1 commit into
godotengine:mainfrom
Ivorforce:usage-update

Conversation

@Ivorforce

Copy link
Copy Markdown
Member

We just had someone confused about the entry_symbol section in Discord.

I decided to have a quick look over the document and address some issues:

  • Guide users the full way to running the project.
  • Make it clearer that changing the names is not immediately required, to get them started faster.
  • Add some links to make it easier to navigate.

@Ivorforce Ivorforce added the enhancement New feature or request label Oct 25, 2025
@dsnopek

dsnopek commented Oct 27, 2025

Copy link
Copy Markdown
Contributor

Make it clearer that changing the names is not immediately required, to get them started faster.

I think it's good to tell people to change the name of the entry symbol right away, because once things are working, it seems likely that folks will forget to come back and change it. And on some platform the dynamic linker will do really strange things if you load two libraries that have the same exported symbol, and by the time folks encounter that issue, it will be non-obvious to come back to the entry symbol.

@Ivorforce
Ivorforce force-pushed the usage-update branch 2 times, most recently from 68509e9 to 424593c Compare October 27, 2025 13:22
@Ivorforce

Ivorforce commented Oct 27, 2025 •

Copy link
Copy Markdown
Member Author

Makes sense. I changed the structure to interweave it with the setup instructions again.

@dsnopek dsnopek left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! This looks good to me :-)

The only thought I have is that this removes the note about the docs in doc_classes/ and it would be nice to say something about it, but I'm not sure where it should say it, so I think this is fine for now

@paddy-exe paddy-exe left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍🏻

@paddy-exe
paddy-exe merged commit 030f0aa into godotengine:main Nov 7, 2025
57 checks passed
@Ivorforce
Ivorforce deleted the usage-update branch November 7, 2025 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants