[Migrated] Improve documentation to include visual of what example app should look like?
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 3.4k
- Forks
- 125
- PR merge metrics
- No merged PRs in 30d
Description
Issue automatically imported from old repo: https://github.com/EmbarkStudios/rust-gpu/issues/1108
Old labels: t: enhancement
Originally creatd by JulianKnodt on 2023-12-16T19:14:48Z
I was hoping to learn how to write rust-gpu shaders, so I was going through the tutorial, and have to run the CPU version on my old mac air.
I think for rendering, it may be useful to include images, as I'm not sure if this output looks correct:
Specifically it may be useful to include an image after the initial build steps to make sure that it's running correctly.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start from the tutorial's initial build steps and the example app output described in the issue, using the supplied image as the reference. Update the relevant tutorial documentation with a visual showing the expected rendering after the initial build, so readers can verify that their example is running correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100