From 95b82a95378c2900f7d1d7908cee322b5f3bf120 Mon Sep 17 00:00:00 2001 From: Charles Giessen <46324611+charles-lunarg@users.noreply.github.com> Date: Thu, 22 Apr 2021 23:47:07 -0600 Subject: [PATCH] Add mention of needing to link to the dynamic linker on linux If a user copy/pastes the code into their project, they need to link to the dynamic linker on linux platforms. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 7535a5e..70b0792 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,12 @@ Copy the `src/VkBootstrap.h` and `src/VkBootstrap.cpp` files into your project, `vk-bootstrap` is *not* a header only library, so no need to worry about macros in the header. +#### Linux specific + +vk-bootstrap will load the required symbols at runtime, which requires that the application is linked to the system dynamic link. +How the dynamic linker is linked into the project depends on the build system in question. +If CMake is being used, link vk-bootstrap with `${CMAKE_DL_LIBS}`. + ### git-submodule + CMake Add this project as a git-submodule into the root directory. Suggested is using a subdirectory to hold all submodules.