Skip to content

Commit ab086a5

Browse files
authored
Merge pull request #79 from gpx1000/update-readme
Update README
2 parents f24df05 + a2821b2 commit ab086a5

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

README.adoc

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,53 @@ The Khronos Vulkan^®^ Tutorial is based on the "link:https://vulkan-tutorial.co
88

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

11+
== Project Structure
12+
13+
The repository is organized into several important directories:
14+
15+
* `en/` - Contains the tutorial content in English, organized by chapters
16+
* `attachments/` - Contains code examples, shader files, and resources used in the tutorial
17+
* `images/` - Contains illustrations, diagrams, and screenshots used in the tutorial
18+
* `scripts/` - Contains utility scripts, including dependency installation scripts
19+
* `antora/` - Contains configuration files for the Antora documentation system
20+
21+
== Installation Dependencies
22+
23+
The project provides scripts to help you install the necessary dependencies:
24+
25+
=== Linux
26+
Run the following command to install dependencies on Linux:
27+
[source,bash]
28+
----
29+
./scripts/install_dependencies_linux.sh
30+
----
31+
32+
This script detects your package manager (apt, dnf, pacman) and installs the required dependencies, including:
33+
* Build essentials (gcc, cmake, ninja-build)
34+
* GLFW, GLM, tinyobjloader, stb
35+
* X Window System dependencies
36+
37+
It also provides instructions for installing the Vulkan SDK.
38+
39+
=== Windows
40+
Run the following command to install dependencies on Windows:
41+
[source,batch]
42+
----
43+
scripts\install_dependencies_windows.bat
44+
----
45+
46+
This script uses vcpkg to install the required dependencies, including:
47+
* GLFW, GLM, tinyobjloader, stb
48+
49+
You will also need to install the Vulkan SDK separately from https://vulkan.lunarg.com/.
50+
1151
== License
1252

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

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

1960
== Contributing

0 commit comments

Comments
 (0)