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

Abierto Apto para principiantes
#552 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 16 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
76/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
cpp

Línea de trabajo

Lee el capítulo “Development Environment” en 02_Development_environment e identifica dónde se mezclan la configuración general del Vulkan SDK con la configuración específica del repositorio del tutorial y los scripts de dependencias. Separa esas instrucciones e indica que clonar el repositorio y ejecutar los scripts son pasos opcionales para quienes ya tienen un proyecto C++ y una configuración de GLFW/GLM. El trabajo estará terminado cuando el capítulo deje claros los dos métodos de configuración y los pasos opcionales.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
C++
Estrellas
444
Forks
145
Merge medio
12 d 10 h
PR fusionados (30 d)
12

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de KhronosGroup/Vulkan-Tutorial

Todos los issues de KhronosGroup/Vulkan-Tutorial

Issues similares

Más issues de C++

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.