From 403b676ea4c884236abf264f255816cfa293cfeb Mon Sep 17 00:00:00 2001 From: chyyran Date: Mon, 6 Feb 2023 02:20:11 -0500 Subject: [PATCH] doc: indicate need for Vulkan SDK --- .github/workflows/build.yml | 2 ++ README.md | 5 ++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index bc214ad..8c4e069 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -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 diff --git a/README.md b/README.md index 003f547..eff5a73 100644 --- a/README.md +++ b/README.md @@ -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`.