Skip to content

Commit c11afcb

Browse files
Updated book.md, book script, chapters, etc
1 parent df17b20 commit c11afcb

File tree

5 files changed

+23
-18
lines changed

5 files changed

+23
-18
lines changed

book.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,28 @@
11
---
2-
title: Vulkan API Companion Guide
2+
title: The Vulkan API Companion Guide
33
author: Harry Gould
44
rights: MIT License
55
language: en-US
66
---
77

8-
Hello everyone. This is going to be a technical book about the newly published Vulkan specification. We'll go over different topics such as...
8+
# An Introduction
9+
10+
This is going to be a technical book about the newly published Vulkan specification. We'll go over different topics such as:
911

10-
- Extensions
1112
- Getting started
1213
- Instances
13-
- Physical & logical devices
14-
- Queues
15-
- Surfaces
16-
- Swap chains
14+
- Physical and logical devices
1715
- Windowing across different platforms
18-
- And more!
16+
- Surfaces
17+
- Swapchains
18+
- Image layouts
19+
- Image views
20+
- Please see the table-of-contents for more!
1921

2022
## Resources
2123

24+
While resources are added everyday, there are a few I'd thoroughly recommend checking out:
25+
2226
- [Vulkan Quick Reference v1.0](https://www.khronos.org/files/vulkan10-reference-guide.pdf)
2327
- [Vulkan Specification v1.0.9](https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html)
2428
- [Vulkan Specification v1.0.9 + WSI Extensions](https://www.khronos.org/registry/vulkan/specs/1.0-wsi_extensions/xhtml/vkspec.html)
@@ -27,15 +31,15 @@ Hello everyone. This is going to be a technical book about the newly published V
2731

2832
## Code
2933

30-
You can find the Github repository [here](https://github.com/HarryLovesCode/Vulkan-API-Book). For now, only Linux and Windows are **officially** supported.
34+
You can find the repository on Github at [HarryLovesCode/Vulkan-API-Book](https://github.com/HarryLovesCode/Vulkan-API-Book). For now, only Linux and Windows are **officially** supported. However, Android support is in the works.
3135

3236
## Reading the Book
3337

34-
You can find the latest stable version [on the release page](https://github.com/HarryLovesCode/Vulkan-API-Book/releases).
38+
You can find the latest stable version [on the Github releases page](https://github.com/HarryLovesCode/Vulkan-API-Book/releases). Otherwise, you can read it on [Gitbook](https://harrylovescode.gitbooks.io/vulkan-api/content/). If you'd like to build it yourself, you will need *pandoc*, *xetex* (for Linux), and *latex extras* installed.
3539

3640
## Building Code on Linux
3741

38-
To build on Linux, use the following commands:
42+
To build on Linux, you will need to make sure you have Vulkan headers available. Also, you will need `autotools`. When in doubt, look at your distribution's package repositories. You can use these commands.
3943

4044
```sh
4145
git clone https://github.com/HarryLovesCode/Vulkan-API-Book
@@ -46,12 +50,12 @@ autoreconf --install
4650
make -j4
4751
```
4852

49-
Once you've done that, you should find all the binaries located in the `./bin` folder.
53+
Once you've done that, you will find all the binaries located in the `./bin` folder.
5054

5155
## Building Code on Windows
5256

53-
To build on Windows, you'll need Visual Studio 2015. You can find the Visual Studio solution in the root directory of the repository. Just open that and you can pick and choose which chapters to build and run.
57+
To build on Windows, you'll need Visual Studio 2015. You can find the Visual Studio solution in the root directory of the repository. Just open that, choose a startup project, and you're ready to go.
5458

55-
## Who am I?
59+
## A Little About Me
5660

57-
I'm Harry and I'm a young developer who enjoys 3D graphics. I've worked with WebGL, OpenGL, and DirectX and when I heard about Vulkan, I was excited to get started! This is, in a way, and experiment because I'm publishing as I go. Thus, the book may be rough around the edges. Feel free to submit issues or pull requests on Github and add inline comments through Gitbook.
61+
I'm Harry and I'm a young developer who enjoys 3D graphics. I've worked with WebGL, OpenGL, and DirectX and when I heard about Vulkan, I was excited to get started. The publishing of this book is, in a way, and experiment because I'm publishing as I go. Thus, the book may be rough around the edges. Feel free to submit issues or pull requests on Github and add inline comments through Gitbook.

book.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,6 @@ pandoc book.md \
4141
--variable monofont="Fira Mono" \
4242
--variable fontsize="11pt" \
4343
-V geometry:margin="2.0cm" \
44+
--chapters \
4445
--highlight-style tango \
4546
-o VulkanApiBook.pdf

chap05/chap05-linux.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Linux
1+
## Surface Creation on Linux
22

33
We're going to be writing the Linux specific code for getting a surface in this section. While this code may work on another operating system that uses the XCB library, I cannot guarantee it will.
44

chap05/chap05-windows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Windows
1+
## Surface Creation on Microsoft Windows
22

33
We're going to be writing the Windows specific code for getting a surface in this section.
44

chap05/chap05.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Creating a Surface
1+
# Working With Surfaces
22

33
This section is divided up by platform. You must begin with the sections below before clicking on platform. The code below is platform independent and must be included in order to create a surface
44

0 commit comments

Comments
 (0)