Skip to content

Update README #79

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
gpx1000 merged 1 commit into from
Jul 3, 2025
Merged

Update README #79

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
43 changes: 42 additions & 1 deletion README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,53 @@ The Khronos Vulkan^®^ Tutorial is based on the "link:https://vulkan-tutorial.co

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].

== Project Structure

The repository is organized into several important directories:

* `en/` - Contains the tutorial content in English, organized by chapters
* `attachments/` - Contains code examples, shader files, and resources used in the tutorial
* `images/` - Contains illustrations, diagrams, and screenshots used in the tutorial
* `scripts/` - Contains utility scripts, including dependency installation scripts
* `antora/` - Contains configuration files for the Antora documentation system

== Installation Dependencies

The project provides scripts to help you install the necessary dependencies:

=== Linux
Run the following command to install dependencies on Linux:
[source,bash]
----
./scripts/install_dependencies_linux.sh
----

This script detects your package manager (apt, dnf, pacman) and installs the required dependencies, including:
* Build essentials (gcc, cmake, ninja-build)
* GLFW, GLM, tinyobjloader, stb
* X Window System dependencies

It also provides instructions for installing the Vulkan SDK.

=== Windows
Run the following command to install dependencies on Windows:
[source,batch]
----
scripts\install_dependencies_windows.bat
----

This script uses vcpkg to install the required dependencies, including:
* GLFW, GLM, tinyobjloader, stb

You will also need to install the Vulkan SDK separately from https://vulkan.lunarg.com/.

== License

The contents of this repository are licensed as https://creativecommons.org/licenses/by-sa/4.0/[CC BY-SA 4.0], unless stated otherwise.
By contributing to this repository, you agree to license your contributions to the public under that same license.

The code listings in the `code` directory are licensed as https://creativecommons.org/publicdomain/zero/1.0/[CC0 1.0 Universal].
The code listings in the `attachments` directory are licensed as
https://creativecommons.org/publicdomain/zero/1.0/[CC0 1.0 Universal].
By contributing to that directory, you agree to license your contributions to the public under that same public domain-like license.

== Contributing
Expand Down