search

emoon / rust_minifb

Cross platfrom window and framebuffer crate for Rust
MIT License
978 stars 92 forks source link

Extended documentation / examples #286

Open beyarkay opened 2 years ago

beyarkay commented 2 years ago

Love the crate, busy using it for some visualization work for strange attractors. Just want to see if @emoon is open to me adding to the documentation / examples or if there's a particular style they want for them?

I see there are some example scripts, but was thinking about adding references to them so they're more discoverable and adding some more in-line examples to the docs.

If this would be appreciated then I'll get started on it.

emoon commented 2 years ago

Hey! Thanks! :)

That sounds great. What might be possible to do is to add another README.md to the examples directory, add screenshots for each example with some description to each. Then of course it would be possible to add more of them if wanted as well. The general docs could perhaps have an example section or so (or link to the example readme)

I'm open for suggestions here.

beyarkay commented 2 years ago

Okay cool, I like the idea of an examples/README.md for screenshots and then linking to that from the main README/docs. I'll probably end up adding inline comments to the examples as well.

emoon commented 1 year ago

Hey, any progress on this issue?