summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbion howard <bion@atomiclogic.com>2024-03-12 16:31:56 -0400
committerGitHub <noreply@github.com>2024-03-12 16:31:56 -0400
commitb72b3942647bcf681ca66712ebd002ce32db834b (patch)
tree49f13788c445578f5b50ea510d271f25c9e5ff9a
parent01986ac85fa2e5c70df09aeae9c907e27c5d50b2 (diff)
downloadvolk-b72b3942647bcf681ca66712ebd002ce32db834b.tar.gz
Remove "just" implying this is obvious or simple or completely explained
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 30faaf9..8d5ff0b 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@ 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`.
+1. You can 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 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.