Repository navigation
Conversation
…e online tutorial, fix the broken links, and add local build and preview instructions. Fixes KhronosGroup#497.
|
|
||
| It also contains Vulkan usage clarifications, improved synchronization and new content. | ||
| * The primary **Khronos Vulkan Tutorial** updates the traditional link:https://vulkan-tutorial.com/[Vulkan Tutorial by Alexander Overvoorde] to use modern Vulkan features and practices. | ||
| See link:en/00_Introduction.adoc[the introduction] for a quick start. |
|
|
||
| You will also need to install the Vulkan SDK separately from https://vulkan.lunarg.com/. | ||
| The tutorial is written in AsciiDoc and rendered with Antora, so some things that look broken in GitHub's preview, such as missing images or cross-references, are expected. | ||
| See link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] for how to preview AsciiDoc in your editor. |
| The primary Khronos Vulkan Tutorial is based on the "link:https://vulkan-tutorial.com/[Vulkan Tutorial]" by Alexander Overvoorde and is licensed under link:https://creativecommons.org/licenses/by-sa/4.0/[CC BY-SA 4.0]. | ||
| Different parts of the repository are under different licenses: | ||
| the Arm tutorials are also CC BY-SA 4.0, the Holochip tutorials are link:https://www.apache.org/licenses/LICENSE-2.0[Apache-2.0], and code listings are link:https://creativecommons.org/publicdomain/zero/1.0/[CC0 1.0 Universal] where applicable. | ||
| The link:en/00_Introduction.adoc#_attribution[attribution section] of the introduction lists which tutorials are covered by which license, the full license texts are in the `LICENSES` directory, and `REUSE.toml` records which license covers which files. |
| Different parts of the repository are under different licenses: | ||
| the Arm tutorials are also CC BY-SA 4.0, the Holochip tutorials are link:https://www.apache.org/licenses/LICENSE-2.0[Apache-2.0], and code listings are link:https://creativecommons.org/publicdomain/zero/1.0/[CC0 1.0 Universal] where applicable. | ||
| The link:en/00_Introduction.adoc#_attribution[attribution section] of the introduction lists which tutorials are covered by which license, the full license texts are in the `LICENSES` directory, and `REUSE.toml` records which license covers which files. | ||
| See link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] for how contributions are licensed. |
| Humans have reviewed all content of all tutorials and we welcome feedback. | ||
|
|
||
| xref:AI_Assisted_Vulkan/introduction.adoc[LLM-Assistant Vulkan Development] tutorial used for all LLM use in these tutorials and sample code. | ||
| The link:en/AI_Assisted_Vulkan/introduction.adoc[LLM-Assistant Vulkan Development] tutorial used for all LLM use in these tutorials and sample code. |
SaschaWillems
requested changes
Nov 1, 2026
Collaborator
|
Since README.adoc is read directly on GitHub, maybe we should link to the published introduction? That would take readers to the tutorial site, where the navigation and chapter links work correctly. -link:en/00_Introduction.adoc[the introduction]
+link:https://docs.vulkan.org/tutorial/latest/00_Introduction.html[the introduction]No strong preference, though |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
link to the online tutorial, fix the broken links, and add local build and preview instructions. Fixes #497.