Skip to content

Commit 06924b5

Browse files
Readme update (#1229)
* Update third party dependency list and move it to separate file * Add iOS under supported platforms * Update links only visible on github to docs site
1 parent 4838e02 commit 06924b5

File tree

3 files changed

+52
-24
lines changed

3 files changed

+52
-24
lines changed

README.adoc

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ ifdef::site-gen-antora[]
4545
endif::[]
4646

4747
ifndef::site-gen-antora[]
48-
* https://github.com/KhronosGroup/Vulkan-Guide[Vulkan Guide]
49-
* https://vulkan-tutorial.com/[Get Started in Vulkan]
48+
* https://docs.vulkan.org/guide/latest/index.html[Vulkan Guide]
49+
* https://docs.vulkan.org/tutorial/latest/index.html[Get Started in Vulkan]
5050
endif::[]
5151

5252
xref:samples/performance/README.adoc[Performance samples] show the recommended best practice together with real-time profiling information.
@@ -130,8 +130,9 @@ Another option which may help is to run github through a VPN service.
130130

131131
* Windows - xref:./docs/build.adoc#windows[Build Guide]
132132
* Linux - xref:./docs/build.adoc#linux[Build Guide]
133-
* macOS - xref:./docs/build.adoc#macos[Build Guide]
134133
* Android - xref:./docs/build.adoc#android[Build Guide]
134+
* macOS - xref:./docs/build.adoc#macos[Build Guide]
135+
* iOS - xref:./docs/build.adoc#ios[Build Guide]
135136

136137
== Usage
137138

@@ -172,25 +173,7 @@ adb shell am start-activity -n com.khronos.vulkan_samples/com.khronos.vulkan_sam
172173

173174
See link:LICENSE[LICENSE].
174175

175-
This project has some third-party dependencies, each of which may have independent licensing:
176-
177-
* https://github.com/ARM-software/astc-encoder[astc-encoder]: ASTC Evaluation Codec
178-
* https://github.com/vit-vit/CTPL[CTPL]: Thread Pool Library
179-
* https://github.com/docopt/docopt.cpp[docopt]: A C{pp}11 port of the Python argument parsing library
180-
* https://github.com/glfw/glfw[glfw]: A multi-platform library for OpenGL, OpenGL ES, Vulkan, window and input
181-
* https://github.com/g-truc/glm[glm]: OpenGL Mathematics
182-
* https://github.com/KhronosGroup/glslang[glslang]: Shader front end and validator
183-
* https://github.com/ocornut/imgui[dear imgui]: Immediate Mode Graphical User Interface
184-
* https://github.com/ARM-software/HWCPipe[HWCPipe]: Interface to mobile Hardware Counters
185-
* https://github.com/KhronosGroup/KTX-Software[KTX-Software]: Khronos Texture Library and Tools
186-
* https://github.com/gabime/spdlog[spdlog]: Fast C{pp} logging library
187-
* https://github.com/KhronosGroup/SPIRV-Cross[SPIRV-Cross]: Parses and converts SPIR-V to other shader languages
188-
* https://github.com/nothings/stb[stb]: Single-file public domain (or MIT licensed) libraries
189-
* https://github.com/syoyo/tinygltf[tinygltf]: Header only C{pp}11 glTF 2.0 file parser
190-
* https://github.com/nlohmann/json[nlohmann json]: C{pp} JSON Library (included by https://github.com/syoyo/tinygltf[tinygltf])
191-
* https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator[vma]: Vulkan Memory Allocator
192-
* https://github.com/zeux/volk[volk]: Meta loader for Vulkan API
193-
* https://github.com/KhronosGroup/Vulkan-Docs[vulkan]: Sources for the formal documentation of the Vulkan API
176+
This project has several xref:./third_party/README.adoc[third-party dependencies]
194177

195178
This project uses assets from https://github.com/KhronosGroup/Vulkan-Samples-Assets[vulkan-samples-assets].
196179
Each one has its own license.

antora/CMakeLists.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2022-2023 The Khronos Group Inc.
1+
# Copyright 2022-2024 The Khronos Group Inc.
22
# SPDX-License-Identifier: Apache-2.0
33

44
# Configure Vulkan Guide Antora tree with transformed markup files.
@@ -14,7 +14,7 @@ function(gatherAntoraAssets)
1414
samples
1515
scripts
1616
shaders
17-
tests
17+
third_party
1818
)
1919
set(PAGES_DIR_SEARCH)
2020
set(IMAGES_DIR_SEARCH)

third_party/README.adoc

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
////
2+
- Copyright (c) 2019-2024, Arm Limited and Contributors
3+
-
4+
- SPDX-License-Identifier: Apache-2.0
5+
-
6+
- Licensed under the Apache License, Version 2.0 the "License";
7+
- you may not use this file except in compliance with the License.
8+
- You may obtain a copy of the License at
9+
-
10+
- http://www.apache.org/licenses/LICENSE-2.0
11+
-
12+
- Unless required by applicable law or agreed to in writing, software
13+
- distributed under the License is distributed on an "AS IS" BASIS,
14+
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
- See the License for the specific language governing permissions and
16+
- limitations under the License.
17+
-
18+
////
19+
= Vulkan Samples third-party dependencies
20+
// omit in toc
21+
:pp: {plus}{plus}
22+
23+
This project has multiple third-party dependencies, each of which may have independent licensing:
24+
25+
* https://github.com/ARM-software/astc-encoder[astc-encoder]: ASTC Evaluation Codec
26+
* https://github.com/catchorg/Catch2[Catch2]: Modern C++ test framework
27+
* https://github.com/CLIUtils/CLI11[CLI11] Command line parser for C++11 and beyond
28+
* https://github.com/vit-vit/CTPL[CTPL]: Thread Pool Library
29+
* https://github.com/fmtlib/fmt[fmt]: A modern formating library
30+
* https://github.com/glfw/glfw[glfw]: A multi-platform library for OpenGL, OpenGL ES, Vulkan, window and input
31+
* https://github.com/g-truc/glm[glm]: OpenGL Mathematics
32+
* https://github.com/KhronosGroup/glslang[glslang]: Shader front end and validator
33+
* https://github.com/ARM-software/HWCPipe[HWCPipe]: Interface to mobile Hardware Counters
34+
* https://github.com/ocornut/imgui[dear imgui]: Immediate Mode Graphical User Interface
35+
* https://github.com/KhronosGroup/KTX-Software[KTX-Software]: Khronos Texture Library and Tools
36+
* https://github.com/KhronosGroup/OpenCL-Headers[OpenCL]: Khronos OpenCL-Headers
37+
* https://github.com/gabime/spdlog[spdlog]: Fast C{pp} logging library
38+
* https://github.com/KhronosGroup/SPIRV-Cross[SPIRV-Cross]: Parses and converts SPIR-V to other shader languages
39+
* https://github.com/nothings/stb[stb]: Single-file public domain (or MIT licensed) libraries
40+
* https://github.com/syoyo/tinygltf[tinygltf]: Header only C{pp}11 glTF 2.0 file parser
41+
* https://github.com/wolfpld/tracy[tracy]: Frame profiler
42+
* https://github.com/nlohmann/json[nlohmann json]: C{pp} JSON Library (included by https://github.com/syoyo/tinygltf[tinygltf])
43+
* https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator[vma]: Vulkan Memory Allocator
44+
* https://github.com/zeux/volk[volk]: Meta loader for Vulkan API
45+
* https://github.com/KhronosGroup/Vulkan-Docs[Vulkan]: Sources for the formal documentation of the Vulkan API

0 commit comments

Comments
 (0)