Add mention to doc that Git LFS is needed to setup / build project

Aperta Adatta ai principianti
  • Qualcosa non va?
#8 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
git
Ambito
documentation

Direzione di ricerca

Aggiorna README.md per spiegare che Git LFS è necessario per effettuare il checkout di tutti i file e compilare il progetto, inclusi gli header Vulkan e gli asset di esempio mancanti. Inizia leggendo le istruzioni esistenti per la configurazione e la compilazione, quindi verifica che la nuova nota avverta chiaramente i nuovi arrivati di questo prerequisito e della confusione relativa al checkout.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

I have noticed that the following files are above github file size limit, and is thus requiring git lfs to checkout/pull:

Skipped checkout for "donut/nvrhi/thirdparty/Vulkan-Headers/include/vulkan/vulkan_structs.hpp", content not local. Use fetch to download.
Skipped checkout for "donut/nvrhi/thirdparty/Vulkan-Headers/registry/validusage.json", content not local. Use fetch to download.
Skipped checkout for "donut/thirdparty/imgui/examples/libs/glfw/lib-vc2010-32/glfw3.lib", content not local. Use fetch to download.
Skipped checkout for "donut/thirdparty/imgui/examples/libs/glfw/lib-vc2010-64/glfw3.lib", content not local. Use fetch to download.
Skipped checkout for "donut/thirdparty/lz4/tests/goldenSamples/skip.bin", content not local. Use fetch to download.
Skipped checkout for "donut/thirdparty/stb/tests/oversample/oversample.exe", content not local. Use fetch to download.
Skipped checkout for "media/glTF-Sample-Models/2.0/Box With Spaces/glTF/Box With Spaces.bin", content not local. Use fetch to download.
Skipped checkout for "media/glTF-Sample-Models/2.0/BrainStem/glTF-Draco/BrainStem0.bin", content not local. Use fetch to download.
Skipped checkout for "media/glTF-Sample-Models/2.0/BrainStem/glTF/BrainStem0.bin", content not local. Use fetch to download.
Skipped checkout for "media/glTF-Sample-Models/2.0/Sponza/glTF/Sponza.bin", content not local. Use fetch to download.
Checking out LFS objects: 100% (10/10), 31 MB | 0 B/s, done.

It would be nice if the README.md mentions that git LFS is needed as otherwise the project could not be built, as it would be missing some files. (Mainly the first errors would be related to vulkan structs headers missing). This should also reduce the confusion on checking out the example project.

Lingua principale
C++
Stelle
40
Fork
26
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di NVIDIA-RTX/Streamline_Sample

Tutte le issue di NVIDIA-RTX/Streamline_Sample

Issue simili

Altre issue su C++

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.