Confusing and frustrating "Development Environment" chapter — mixing general Vulkan setup with tutorial-specific scripts

Offen Anfängerfreundlich
#552 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 16 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
76/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
cpp
Bereich
documentation

Rechercherichtung

Lies das Kapitel „Development Environment“ in 02_Development_environment und ermittle, an welchen Stellen die allgemeine Vulkan-SDK-Einrichtung mit der tutorialspezifischen Einrichtung des Repositorys und den Abhängigkeitsskripten vermischt ist. Trenne diese Anweisungen und stelle klar, dass das Klonen des Repositorys und das Ausführen der Skripte für Nutzer mit einem vorhandenen C++-Projekt und einer GLFW/GLM-Einrichtung optional sind. Fertig ist die Aufgabe, wenn das Kapitel die beiden Einrichtungswege und die optionalen Schritte klar darstellt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

In the "Development Environment" chapter (02_Development_environment), the documentation promises to "set up your environment for developing Vulkan applications", yet immediately forces the user to clone the entire Vulkan-Tutorial repository and run system-wide Dependency Install Scripts (install_dependencies_windows.bat / install_dependencies_linux.sh).
This is extremely confusing and frustrating for newcomers:

  1. Misleading structure: Setting up a general Vulkan environment (installing the Vulkan SDK and a compiler) is mixed up with setting up dependencies for this specific tutorial's codebase.
  2. Risky and fragile scripts: If a developer already has the Vulkan SDK, an IDE, and libraries like GLFW/GLM configured, running opaque system-wide installation scripts is completely unnecessary. Worse, these scripts are fragile, easily break depending on the user's environment, and waste hours of debugging time just to get started.
    Suggestion:
    Please clearly separate the general Vulkan SDK setup from the tutorial-specific template/dependencies, and state upfront that cloning the repo and running install scripts are strictly optional if the user already has a working C++ project with GLFW/GLM.
Vorherrschende Sprache
C++
Sterne
444
Forks
145
Ø Merge
12 T. 10 Std.
Gemergte PRs (30 T.)
12

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus KhronosGroup/Vulkan-Tutorial

Alle Issues in KhronosGroup/Vulkan-Tutorial

Ähnliche Issues

Weitere Issues zu C++

Neue Issues direkt in Ihr Postfach

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