summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArseny Kapoulkine <arseny.kapoulkine@gmail.com>2024-02-21 11:49:01 -0800
committerGitHub <noreply@github.com>2024-02-21 11:49:01 -0800
commit5982311be42f8277cad11ae4637c80ab69c79ce5 (patch)
tree4806b291f1853c1acbe5efa29814749024de4564
parent7dd9164218fb44578b5c32a60f997f774fc1ec18 (diff)
downloadvolk-5982311be42f8277cad11ae4637c80ab69c79ce5.tar.gz
Update README.md
Add a note that volk.c is still required when VOLK_IMPLEMENTATION is used per #174
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index 1cb3299..30faaf9 100644
--- a/README.md
+++ b/README.md
@@ -13,8 +13,8 @@ volk is written in C89 and supports Windows, Linux, Android and macOS (via Molte
There are multiple ways to use volk in your project:
1. You can just add `volk.c` to your build system. Note that the usual preprocessor defines that enable Vulkan's platform-specific functions (VK_USE_PLATFORM_WIN32_KHR, VK_USE_PLATFORM_XLIB_KHR, VK_USE_PLATFORM_MACOS_MVK, etc) must be passed as desired to the compiler when building `volk.c`.
-2. You can use volk in header-only fashion. Include `volk.h` wherever you want to use Vulkan functions. In exactly one source file, define `VOLK_IMPLEMENTATION` before including `volk.h`. Do not build `volk.c` at all in this case. This method of integrating volk makes it possible to set the platform defines mentioned above with arbitrary (preprocessor) logic in your code.
-3. You can use provided CMake files, with the usage detailed below.
+2. You can use provided CMake files, with the usage detailed below.
+3. You can use volk in header-only fashion. Include `volk.h` wherever you want to use Vulkan functions. In exactly one source file, define `VOLK_IMPLEMENTATION` before including `volk.h`. Do not build `volk.c` at all in this case - however, `volk.c` must still be in the same directory as `volk.h`. This method of integrating volk makes it possible to set the platform defines mentioned above with arbitrary (preprocessor) logic in your code.
## Basic usage