alex/librashader
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

doc: add build instructions

Browse source
This commit is contained in:
chyyran 2023-01-14 17:29:26 -05:00
parent c85565a8f7
commit a645bf0622
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -37,6 +37,21 @@ The C API currently does not expose the [shader reflection API](https://docs.rs/
is in progress to expose this to C. In the meanwhile, if you wish to implement a custom runtime for librashader, it will have to be done is in progress to expose this to C. In the meanwhile, if you wish to implement a custom runtime for librashader, it will have to be done
in Rust. in Rust.
### Building
For Rust projects, simply add the crate to your `Cargo.toml`
```
cargo add librashader
```
To build the C compatible dynamic library, [cargo-post](https://crates.io/crates/cargo-post) is required.
```
cargo post build --release --package librashader-capi
```
This will output a `librashader.dll` or `librashader.so` in the target folder.
### C ABI Compatibility ### C ABI Compatibility
The recommended way of integrating `librashader` is by the `librashader_ld` single header library, ABI stability The recommended way of integrating `librashader` is by the `librashader_ld` single header library, ABI stability
is important to ensure that updates to librashader do not break existing consumers. is important to ensure that updates to librashader do not break existing consumers.