Add README to example-showcase tool
- Dominant language
- Rust
- Stars
- 48.2k
- Forks
- 4.8k
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 171
Description
Confusion and answers start here: https://discord.com/channels/691052431525675048/743663924229963868/1391561061349593173
What:
> it's the tool that power https://bevyengine.github.io/bevy-example-runner/ among other things
> and https://bevy.org/examples/
Why:
> because CI nodes are not very powerful and the default config is too much for them
Why patching:
> why do we rely on patching for this?
> because it can't modify the example code
Contributor guide
Research direction
Start by locating the example-showcase tool and reviewing how it powers the Bevy example runner and the bevy.org examples. The README should explain the tool's purpose, why CI uses a reduced default configuration, and why patching is used; done means a newcomer can understand these points without relying on the linked discussion.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100