Mention somewhere that the latest commit should be used
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 3.4k
- Forks
- 125
- PR merge metrics
- No merged PRs in 30d
Description
In the initial crate setup as mentioned in the book, it tells you to setup spirv_builder by adding the 0.9 version to your Cargo.toml: https://rust-gpu.github.io/rust-gpu/book/writing-shader-crates.html#using-spirv-builder
This of course does not work because the last spirv_builder release is ancient. In fact, the rust-toochain.toml mentioned immediately before this does not match the one from spirv_builder so upon doing this the crate won't even compile. This is easy enough to fix:
[build-dependencies]
# maybe use a commit if you need some semblance of stability
spirv-builder = { git = "https://github.com/Rust-GPU/rust-gpu", revision = "master" }
Figuring this out however was challenging. I feel like this should be mentioned somewhere in this section of the book.
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 with the “Using spirv-builder” section of the book at writing-shader-crates.html and compare its spirv_builder 0.9 setup with the repository’s current setup. Update the section to explain that the latest commit or a suitable git revision should be used, and ensure the guidance matches the mentioned rust-toochain.toml. Done means a newcomer is warned that the old release does not work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100