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

[Documentation] Update "Quick Start" to include new Initialize signature #201

Closed
EmmanuelMess opened this issue Jan 14, 2025 · 7 comments
Closed
Labels
Attempted Fix A fix has been implemented but not yet confirmed by the issue reporter.

Comments

@EmmanuelMess
Copy link

Currently the example in the readme is difficult to copy and has problems with the Clay_Initialize function that now takes 3 args.

@nicbarker
Copy link
Owner

Hi @EmmanuelMess, thanks for reporting this, I've fixed up the example here: 5f7176c

@nicbarker nicbarker added the Attempted Fix A fix has been implemented but not yet confirmed by the issue reporter. label Jan 21, 2025
@nicbarker nicbarker changed the title Provide correct example in the readme [Documentation] Update "Quick Start" to include new Initialize signature Jan 21, 2025
@EmmanuelMess
Copy link
Author

Hi @EmmanuelMess, thanks for reporting this, I've fixed up the example here: 5f7176c

Thanks, but the idea was to also make the example be a complete one (without the //...) even if its smaller than it currently is. Or maybe make it a block of code with comments explaining the steps?

@EmmanuelMess
Copy link
Author

Check the basic example of https://github.com/raysan5/raylib

@nicbarker
Copy link
Owner

Ah I see, you'd prefer the quick start to be a single large block of code?

@EmmanuelMess
Copy link
Author

Ah I see, you'd prefer the quick start to be a single large block of code?

Yes, but I also think other people would prefer it too.

@cD1rtX3
Copy link

cD1rtX3 commented Jan 24, 2025

Ah I see, you'd prefer the quick start to be a single large block of code?

I agree that it should be a single block of code with explanations for each line underneath.

@nicbarker
Copy link
Owner

As of 4612481 and cb62db7 the documentation has been updated to include a single block, thanks for raising the issue! 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Attempted Fix A fix has been implemented but not yet confirmed by the issue reporter.
Projects
None yet
Development

No branches or pull requests

3 participants