Rust-GPU / Rust-GPU/rust-gpu

Mention somewhere that the latest commit should be used

Offen
#479 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement
Vorherrschende Sprache
Rust
Sterne
3.4k
Forks
126
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit dem Abschnitt „Using spirv-builder“ des Buchs unter writing-shader-crates.html und vergleiche dessen Einrichtung von spirv_builder 0.9 mit der aktuellen Einrichtung im Repository. Aktualisiere den Abschnitt so, dass erklärt wird, dass der neueste Commit oder eine geeignete git revision verwendet werden sollte, und stelle sicher, dass die Anleitung mit der erwähnten rust-toochain.toml übereinstimmt. Als erledigt gilt die Aufgabe, wenn ein Neuling darauf hingewiesen wird, dass das alte Release nicht funktioniert.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
rust
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
55/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.