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.

Sign up for GitHub

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

Jump to bottom

Internal Docs #30

Open
VisenDev opened this issue Oct 4, 2023 · 4 comments
Open

Internal Docs #30

VisenDev opened this issue Oct 4, 2023 · 4 comments

Comments

@VisenDev
Copy link
Contributor

VisenDev commented Oct 4, 2023

It would be great if some more of the internals were documented, eg, what functionality is implemented where, naming conventions, etc...
@VisenDev
Copy link
Contributor Author

VisenDev commented Oct 4, 2023

Possibly a contributor.md or a src/README.md could be added for this purpose?

@foxnne
Copy link
Owner

foxnne commented Oct 4, 2023

This is a great idea! I apologize for not documenting it along the way, it's just still early on and I completely switched from zglfw/zgpu to mach-core pretty recently, so lots changed then as well.

I'll try to start working on it as soon as I can and give as much info as I can, sorry if this is holding you up!

@foxnne
Copy link
Owner

foxnne commented Oct 5, 2023

I've started documenting things in contributor.md, and will continue adding as much information as I can. Please let me know here if anyone has any questions or topics I can cover that would be helpful :)

@VisenDev
Copy link
Contributor Author

VisenDev commented Oct 5, 2023

Awesome thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@VisenDev @foxnne