search

foxnne / pixi

Pixel art editor made with Zig.
https://foxnne.github.io/pixi/
MIT License
773 stars 25 forks source link

Internal Docs #30

Open VisenDev opened 1 year ago

VisenDev commented 1 year ago

It would be great if some more of the internals were documented, eg, what functionality is implemented where, naming conventions, etc...

VisenDev commented 1 year ago

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

foxnne commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

Awesome thank you!