Improve .cargo/config section in the Writing Shader Crates documentation

Open Beginner friendly
#209 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

Find the Writing Shader Crates documentation and locate the “Clone the rust-gpu repository” and “cargo build --release” instructions. Update the clone command and build command exactly as requested, then verify the section reflects the reduced checkout and targeted build.

Written by the indexing model from the issue text.

Description

enhancement
  1. Add git clone https://github.com/Rust-GPU/rust-gpu.git --depth 1 to the end of "Clone the rust-gpu repository"
  2. Change "cargo build --release in rust-gpu" into "cargo build -r -p rustc_codegen_spirv in rust-gpu"

These small changes may reduce the downloading and compiling time as well as space occupation for new users.

Dominant language
Rust
Stars
3.4k
Forks
126
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Rust-GPU/rust-gpu

All issues in Rust-GPU/rust-gpu

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.