Skip to content

Commit c7e361c

Browse files
committed
Update guide pages
1 parent afc1a36 commit c7e361c

File tree

3 files changed

+11
-3
lines changed

3 files changed

+11
-3
lines changed

guide/src/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,9 @@ Some examples of what this guide _does not_ focus on:
2525

2626
- GPU-driven rendering
2727
- Real-time graphics from ground-up
28-
- Considerations for tiled GPUs (eg mobile devices / Android)
28+
- Considerations for tiled GPUs (eg mobile devices / Android)
29+
30+
## Source
31+
32+
The source code for the project (as well as this guide) is located in [this repository](https://github.com/cpp-gamedev/learn-vulkan). A `section/*` branch intends to reflect the state of the code at the end of a particular section of the guide. Bugfixes / changes are generally backported, but there may be some divergence from the current state of the code (ie, in `main`). The source of the guide itself is only up-to-date on `main`, changes are not backported.
33+

guide/src/SUMMARY.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616
- [Vulkan Device](initialization/device.md)
1717
- [Scoped Waiter](initialization/scoped_waiter.md)
1818
- [Swapchain](initialization/swapchain.md)
19+
20+
# Hello Triangle
21+
1922
- [Rendering](rendering/README.md)
2023
- [Swapchain Loop](rendering/swapchain_loop.md)
2124
- [Render Sync](rendering/render_sync.md)

guide/src/getting_started/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Vulkan is platform agnostic, which is one of the main reasons for its verbosity: it has to account for a wide range of implementations in its API. We shall be constraining our approach to Windows and Linux (x64 or aarch64), and focusing on discrete GPUs, enabing us to sidestep quite a bit of that verbosity. Vulkan 1.3 is widely supported by the target desktop platforms and reasonably recent graphics cards.
44

5-
> _This doesn't mean that eg an integrated graphics chip will not be supported, it will just not be particularly designed/optimized for._
5+
> This doesn't mean that eg an integrated graphics chip will not be supported, it will just not be particularly designed/optimized for.
66
77
## Technical Requirements
88

@@ -31,4 +31,4 @@ The project uses a "Build the World" approach, enabling usage of sanitizers, rep
3131
1. While Vulkan is a C API, it offers an official C++ wrapper library with many quality-of-life features. This guide almost exclusively uses that, except at the boundaries of other C libraries that themselves use the C API (eg GLFW and VMA).
3232
1. [Vulkan Memory Allocator](https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator/) for dealing with Vulkan memory heaps
3333
1. [GLM](https://github.com/g-truc/glm) for GLSL-like linear algebra in C++
34-
1. [Dear ImGui](https://github.com/ocornut/imgui) for UI
34+
1. [Dear ImGui](https://github.com/ocornut/imgui) for UI

0 commit comments

Comments
 (0)