doc: indicate need for Vulkan SDK

This commit is contained in:
chyyran 2023-02-06 02:20:11 -05:00
parent 4dcbdadb4f
commit 403b676ea4
2 changed files with 6 additions and 1 deletions

View file

@ -39,6 +39,8 @@ jobs:
name: Setup Python
with:
python-version: '3.x'
- run: pip install meson ninja mako
name: Install Meson for spirv-to-dxil-sys
- name: Build dynamic library
run: cargo post build --release --package librashader-capi
- name: Upload build artifacts

View file

@ -37,11 +37,14 @@ The librashader C API is best used by linking statically with `librashader_ld`,
loads the librashader (`librashader.so` or `librashader.dll`) implementation in the search path.
### Building
Some downstream dependencies require some Python dependencies to build.
The [Vulkan SDK](https://www.lunarg.com/vulkan-sdk/) is required to build librashader. Some additional Python dependencies
are also required to build downstream dependencies.
```
pip install meson ninja mako
```
---
For Rust projects, simply add the crate to your `Cargo.toml`.