Closed sunjay closed 4 years ago
I think I can help with this. Should I include the GIFs from a new examples/images
directory @sunjay? Also, I find the "Example Source Code" title a bit misleading: I first understood it as "example code to use this example", so should I put it as "Source Code" or even just "Source"?
I think I can help with this.
Thanks! That would be great!
Should I include the GIFs from a new
examples/images
directory @sunjay?
Good question. Let's put them into a new docs/assets/images/examples
folder. Please name the files the same as the examples to make this easy to keep track of. You can use numbers at the end of the file name to add multiple images: e.g. maze.gif
, snowman1.png
, snowman2.png
, etc.
Also, I find the "Example Source Code" title a bit misleading: I first understood it as "example code to use this example", so should I put it as "Source Code" or even just "Source"?
Source Code
is good. The goal is just to make sure that people understand that the code that produces the image is at that link.
Then this can be closed now, right?
Yup! Thanks!
It's a good idea to have a sort of "index page" in the examples directory which lists some of the more prominent examples with gifs of their functioning.
Implementation Steps
If you have any questions about any of these steps or need more details, please comment below!
examples/README.md
Add the following content:
Gifs
Here are some gifs that could be included:
For
examples/maze.rs
:For
examples/rust.rs
:For
examples/heart.rs
: