Improvements to the development enviroment section
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 68/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Attiva
- Stack tecnologico
- cmake, cpp
- Ambito
- build-system, documentation
Direzione di ricerca
Individua la sezione Development_enviroment e 00_introduction.adoc, quindi esamina le istruzioni di configurazione, gli script e gli esempi di attachments esistenti. Documenta come compilare ed eseguire un esempio dalla relativa cartella build//Debug, spiega l'output previsto, come lo schermo nero, e aggiungi il quick-start concordato oppure rinomina la sezione. Verifica i comandi e il percorso dell'esempio rispetto al repository.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Summary
Currently, after compiling the project is not clear how to check if your enviroment is valid.
The binaries will launch a black screen, so beginners might believe they have a wrong enviroment.
Proposed changes
Add a section on running examples
I would recommend adding a final section explaining that most binaries will produce a black screen, along with a table containing some tutorial binaries, the name, expected image, and folder to run them.
It is also not clear that binaries have to be run from their build\<filename>\Debug folder, so we should explain that.
Add a quick start section
I am not sure about this. I wonder whether we should add a small Quick start section with just the basic steps. This should make it easier for people to just build and test the repository:
- Install vcpkg
- Run the installation script for your plaform.
- Linux:
scripts/install_dependencies_windows.bat- Windows:
scripts/install_dependencies_windows.bat- Read
Common considerationssfor more details- Create a CMake project for your favorite IDE
- From attachments:
cmake -B build -S . -DCMAKE_TOOLCHAIN_FILE=[path\to\vcpkg]\scripts\buildsystems\vcpkg.cmake- Read
Setting up a CMake project- You should be able to open, compile and run the project on your favorite IDE
- Alternatively:
- Compile with
cmake --build .\build- This will generate binaries for each the step in the tutorial.
- Go to the expected directory
cd attachments\build\28_model_loading\Debug- Run:
.\28_model_loading.exe
- You should view something similar to this
Having an image like this at the beginning also indicates what you will learn to do by following the tutorial. I think we also add and to 00_introduction.adoc.
Rename the section
Not sure if Development_enviroment is the best name. I think we should include build in the name.
Some people might just want to test if they can use Vulkan in their machine, before they start to follow the tutorial.
I think this section will be more easy to find as Build_and_development_enviroment
- Lingua principale
- C++
- Stelle
- 424
- Fork
- 127
- Merge medio
- 2g 22h
- PR unite (30g)
- 7
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di KhronosGroup/Vulkan-Tutorial
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
KhronosGroup/Vulkan-Tutorial#519 · 1 assegnatario ·
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
KhronosGroup/Vulkan-Tutorial#511 · 1 assegnatario ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
KhronosGroup/Vulkan-Tutorial#508 · 1 assegnatario ·
-
Non-C/C++ Vulkan development Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 74/100
KhronosGroup/Vulkan-Tutorial#499 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
KhronosGroup/Vulkan-Tutorial#498 ·
Tutte le issue di KhronosGroup/Vulkan-Tutorial
Issue simili
-
enhancement
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
QuantStack/git2cpp#187 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
mlcommons/mobile_app_open#1182 ·
-
Needs-Triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
microsoft/winget-cli#6547 ·
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
AXERA-TECH/ax-llm#77 ·