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

オープン 初心者向け
#552 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 16 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
76/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
cpp
領域
documentation

調査の方向性

02_Development_environment の「Development Environment」章を読み、一般的な Vulkan SDK のセットアップが、チュートリアル固有のリポジトリのセットアップや依存関係スクリプトと混在している箇所を特定してください。これらの手順を分け、既存の C++ プロジェクトと GLFW/GLM のセットアップがあるユーザーにとって、リポジトリのクローンとスクリプトの実行は任意であることを明記してください。この章で2つのセットアップ方法と任意の手順が明確になれば完了です。

索引モデルが issue の本文から書いたものです。

説明

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.
主要言語
C++
スター
444
フォーク
145
平均マージ
12日 10時間
マージ済み PR(30日)
12

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

KhronosGroup/Vulkan-Tutorial のほかの issue

KhronosGroup/Vulkan-Tutorial の issue をすべて見る

似ている issue

C++ の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。