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

Ouverte Adaptée aux débutants
#552 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 16 jours

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
76/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
cpp
Domaine
documentation

Piste de recherche

Lis le chapitre « Development Environment » dans 02_Development_environment et repère où la configuration générale du Vulkan SDK est mêlée à la configuration du dépôt propre au tutoriel et aux scripts de dépendances. Sépare ces instructions et précise que le clonage du dépôt et l’exécution des scripts sont facultatifs pour les personnes qui disposent déjà d’un projet C++ et d’une configuration GLFW/GLM. Le chapitre sera terminé lorsqu’il présentera clairement les deux parcours de configuration et les étapes facultatives.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.
Langage dominant
C++
Étoiles
444
Forks
145
Merge moyen
12 j 10 h
PR mergées (30 j)
12

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de KhronosGroup/Vulkan-Tutorial

Toutes les issues de KhronosGroup/Vulkan-Tutorial

Issues similaires

Plus d'issues C++

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.