Skip to content

Add in updated contributors and the LLM disclosure. #428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marty-johnson59 merged 1 commit into from
Jul 16, 2026
+37 −1
Merged

Add in updated contributors and the LLM disclosure. #428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,22 @@

The Khronos Vulkan^®^ Tutorial is based on the "link:https://vulkan-tutorial.com/[Vulkan Tutorial]" by Alexander Overvoorde licensed under link:https://creativecommons.org/licenses/by-sa/4.0/[CC BY-SA 4.0].

The following tutorials were written by Holochip Corporation and released under the link:https://www.apache.org/licenses/LICENSE-2.0[Apache-2.0]:

* xref:ML_Inference/introduction.adoc[Machine learning inference]
* xref:OpenXR_Vulkan_Spatial_Computing/introduction.adoc[Vulkan for XR]
* xref:AI_Assisted_Vulkan/introduction.adoc[LLM-Assistant Vulkan Development]
* xref:Advanced_glTF/introduction.adoc[Advanced glTF]
* xref:Advanced_Vulkan_Compute/introduction.adoc[Advanced Vulkan Compute]
* xref:Building_a_Simple_Engine/introduction.adoc[Building a Simple Game Engine]
* xref:Synchronization/introduction.adoc[Synchronization]
* xref:Building_a_Simple_Engine/Courses/Opacity_Micromaps/00_introduction.adoc[Opacity Micromaps mini course]

The following courses were written by Arm Limited and released under link:https://creativecommons.org/licenses/by-sa/4.0/[CC BY-SA 4.0].

@SaschaWillems SaschaWillems Jul 16, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least the SIGGRAPH 2026 one is licensed under MIT

Raytracing does not state what license it falls under.

@iagoCL iagoCL Jul 16, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We choose MIT for the code as it is a common and simple license, so code in tutorials using it are easy to adopt by developers, and MIT should be "compatible" with cc-by-4.0.

The default license for the repository is cc-by-4.0 so it should apply to the course content.
We can consider adding or changing the licenses  if it will make things easier.

@gpx1000 gpx1000 Jul 16, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As this PR was merged, I did remove the "and released under..." portion of the sentence as I didn't want to speak for Arm. You guys can select whichever license. We (Holochip) are already using a different license for the new tutorials those are wholly separate from the core tutorial.
The first course does depend upon the core tutorial so I thought it might want to chose to remain on the same CC-BY but again i'm not speaking for you guys ;-). I think the new course is wholly separate so it makes sense to be in whichever license you want.

@iagoCL iagoCL Jul 17, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We added the MIT License for the code, but my understanding is that the course materials and slides are licensed under CC BY-SA 4.0.

This should allow people to reuse and adapt the code in their own projects while also adapting and extending the course materials, which we're happy to encourage. For example, universities could use it as the basis for their own courses, or people could create Vulkan courses in other languages.

We're happy to leave things as they are, but we can also make changes if you prefer. For example, we could:

  • Revisit the licensing for our content, we can consider relicensing the Arm tutorials under MIT, Apache 2.0, CC BY 4.0, or an appropriate combination. I think the current licensing arrangement works well. SIGGRAPH content is already cc-by 4.0
  • Add a comment to the relevant files explaining which license applies to each file. If we expect to continue using multiple licenses, it would probably be a good idea to start adding something like the following to all AsciiDoc files:
// Copyright (c) 2026 Khronos Group
// Copyright (c) 2026 Arm
// SPDX-License-Identifier: CC-BY-4.0 OR Apache-2.0

I would keep the licenses as they are, but personally I think we should require adding a comment with the license to all .adoc files in the repository.


* xref:courses/18_Ray_tracing/00_Overview.adoc[SIGGRAPH 2025: Hands-on Vulkan Ray Tracing with Dynamic Rendering]
* xref:courses/siggraph2026_vk_tutorial/00_Overview.adoc[SIGGRAPH 2026: How to write a Vulkan application in 2026]

== About

This repository hosts the contents of the link:https://docs.vulkan.org/tutorial/latest[Khronos Vulkan Tutorial]. The tutorial is part of the link:https://github.com/KhronosGroup/Vulkan-Site[Vulkan Documentation Project].
Expand Down Expand Up @@ -78,3 +94,18 @@ By contributing to that directory, you agree to license your contributions to th
== Contributing

Contributions are welcome, details on how to contribute and the technical requirements that have to be met can be found in link:CONTRIBUTING.adoc[this document].

[NOTE]
====
Claude and Gemini along with local SLMs were used to assist in writing these tutorials.

AI was used for:

* Reviewing, with a particular focus on spelling and grammar.
* Assisting with small refactors
* Generating generic language between human created content.

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.
====
2 changes: 1 addition & 1 deletion REUSE.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ SPDX-License-Identifier = "CC0-1.0"
[[annotations]]
path = "attachments/CMake/FindVulkan.cmake"
precedence = "closest"
SPDX-FileCopyrightText = "Holochip Inc."
SPDX-FileCopyrightText = "Holochip Corporation"
SPDX-License-Identifier = "BSD-3-Clause"

[[annotations]]
Expand Down
5 changes: 5 additions & 0 deletions en/00_Introduction.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ The following tutorials were written by Holochip Corporation and released under
* xref:Synchronization/introduction.adoc[Synchronization]
* xref:Building_a_Simple_Engine/Courses/Opacity_Micromaps/00_introduction.adoc[Opacity Micromaps mini course]

The following courses were written by Arm Limited and released under link:https://creativecommons.org/licenses/by-sa/4.0/[CC BY-SA 4.0].

* xref:courses/18_Ray_tracing/00_Overview.adoc[SIGGRAPH 2025: Hands-on Vulkan Ray Tracing with Dynamic Rendering]
* xref:courses/siggraph2026_vk_tutorial/00_Overview.adoc[SIGGRAPH 2026: How to write a Vulkan application in 2026]

== Differences

Compared to the original tutorial, this version of the tutorial is teaching up-to-date concepts:
Expand Down
Loading