Skip to content

Commit

Permalink
Removed out of date VulkanSDK download and unpack instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
robertosfield committed May 21, 2024
1 parent 422c7a9 commit 2ec6fb7
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 17 deletions.
10 changes: 5 additions & 5 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@

### Installing dependencies

* Ubuntu:
`sudo apt-get install cmake-curses-gui g++ git libvulkan-dev`
* Ubuntu:

This comment has been minimized.

Copy link
@AnyOldName3

AnyOldName3 May 21, 2024

Contributor

It's possibly worth specifying that this is for Ubuntu 24.04 and later, as earlier versions don't have new enough glslang-dev

This comment has been minimized.

Copy link
@robertosfield

robertosfield May 21, 2024

Author Collaborator

Perhaps moving glslang-dev glslang-tools out into a sperate line then qualifying it w.r.t version number.

`sudo apt-get install cmake-curses-gui g++ git libvulkan-dev glslang-dev glslang-tools

* Gentoo:
* Gentoo:
`emerge dev-util/vulkan-tools`

### Build
Expand Down Expand Up @@ -207,7 +207,7 @@ For example, a bare minimum CMakeLists.txt file adding the mentioned cmake targe

### Using VSG provided cmake macro to generate cmake support files

Projects that install a library must generate some cmake-related files so that the library can be found by ```find_package()```. To simplify the generation of these files, the cmake macro ```vsg_add_cmake_support_files()``` has been added.
Projects that install a library must generate some cmake-related files so that the library can be found by ```find_package()```. To simplify the generation of these files, the cmake macro ```vsg_add_cmake_support_files()``` has been added.

In addition to calling the macro, it requires a template for creating the xxxConfig.cmake file, as given in the following example:

Expand Down Expand Up @@ -323,7 +323,7 @@ So now we're ready to build VSG. With the SDK installed this is very similar to
git clone https://github.com/vsg-dev/VulkanSceneGraph.git
cd VulkanSceneGraph
cmake . -G "Xcode"

Once CMake has finished you can open the generated Xcode project and build the 'install' target. This will build VSG and install the headers and generated library onto your machine.

Again, as with other platforms it's useful to now set your CMAKE_PREFIX_PATH to point to the VSG library we have just installed. If you've installed to the default location you can add the following to your .bash_profile file.
Expand Down
14 changes: 2 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,7 @@ Community projects:

The above dependency versions are known to work so they've been set as the current minimum, it may be possible to build against older versions. If you find success with older versions let us know and we can update the version info.

Download VulkanSDK from [LunarG](https://vulkan.lunarg.com/sdk/home), unpack into local directory and set VULKAN_SDK environment variable to the include/lib directory within it. For Linux it would typically be along the lines of:

export VULKAN_SDK_VERSION=1.2.162.1
export VULKAN_SDK=${PWD}/VulkanSDK/${VULKAN_SDK_VERSION}/x86_64

mkdir VulkanSDK
wget https://sdk.lunarg.com/sdk/download/${VULKAN_SDK_VERSION}/linux/vulkansdk-linux-x86_64-${VULKAN_SDK_VERSION}.tar.gz -O VulkanSDK/vulkansdk-linux-x86_64-${VULKAN_SDK_VERSION}.tar.gz
tar zxf VulkanSDK/vulkansdk-linux-x86_64-${VULKAN_SDK_VERSION}.tar.gz -C VulkanSDK/

Once you've downloaded and unpacked the VulkanSDK you'll want to put VULKAN_SDK into your user environment variable setup so that CMake's find_package(Vulkan) can find the VulkanSDK's location.
While you can install Vulkan and glslang development libraries and headers from 3rd party repositoriesm these may be older, so for the latest versions you can also use the VulkanSDK provided by LunarG. Your can download VulkanSDK from [LunarG](https://vulkan.lunarg.com/sdk/home), unpack into a local directory and set VULKAN_SDK environment variable to the include/lib directory within it.

### Command line build instructions:

Expand All @@ -63,7 +54,6 @@ To build and install the static libvsg library (.a/.lib) in source:
git clone https://github.com/vsg-dev/VulkanSceneGraph.git
cd VulkanSceneGraph
cmake .
make -j 8
sudo make install
cmake --build . -j 16 -t install

Full details on how to build the VSG (Unix/Windows/Android/macOS) can be found in the [INSTALL.md](INSTALL.md) file.

0 comments on commit 2ec6fb7

Please sign in to comment.