Add a readme for the examples #1423
Conversation
|
I think this is a very useful addition. |
|
I was thinking about some clips just like |
|
You can weirdly host media (e.g. animated gifs, maybe .mp4?) in github by attaching it to an issue and then grabbing the url of the uploaded media. You don't need to actually submit the issue for the media to last forever it seems |
|
A better way to do this is to just have an orphan branch of your project and commit your media there; then you can link to it directly. This is how we put the screenshots in the main readme, for instance... |
|
I dont think I will do the inline pictures, its too much work. Thats something that should be a community effort instead of one person imo. |
druid/examples/readme.md
Outdated
| cargo run --example scroll_colors | ||
| ``` | ||
|
|
||
| This is a showcase is scrolling through an image gradient square. The square is devided into smaller squares each with a unique color. There are other ways to to this like one big widget with an image for example. |
There was a problem hiding this comment.
(Actually, I'm not sure what the purpose of this example is, given that we have scroll?)
There was a problem hiding this comment.
yeah it is like the most basic showcase out there, not really doing much imho.
I propose to remove this in another PR?
|
What's the status on this? I accept responsibility for it sitting for so long, but I think we should either get it merged or remove it? It would also be good to have a checklist of things to do when adding a new example (like adding it to this readme, ignoring it on wasm if needed, etc...) |
|
I completely forgot about this, yes I still want to get this merged. I will take a look at what examples are still missing and if its not too many add them. I think the contributing section should be in a separate file just like in the root, and probably also another PR to not keep this one blocked on that. |
|
yep that sounds good! |
Co-authored-by: Colin Rofls <colin@cmyr.net>
Co-authored-by: Colin Rofls <colin@cmyr.net>
Co-authored-by: Colin Rofls <colin@cmyr.net>
Co-authored-by: Colin Rofls <colin@cmyr.net>
Co-authored-by: Colin Rofls <colin@cmyr.net>
JAicewizard
force-pushed
the
example_readme
branch
from
757904d
to
a81d4b7
Compare
|
@cmyr I think I did implemented every example in here. As I am not the original author of these examples I dont know their exact purposes, but that's for future example authors to fix imo. |
|
@jneem I fixed the typo. I think if you mark it as resolved, we can merge the PR? |
|
going to make the executive to just ignore any outstanding reviews or CI and just merge this as-is, thank you for the patience everyone! |
The list is not complete yet, I will add every example after I take a look at them.
You can merge it now or wait until I've looked at all the examples.