diff --git a/README.md b/README.md index ad2a7206d2..dd9a9cc1b7 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,30 @@ # mikktspace-rs [![crates.io](https://img.shields.io/crates/v/mikktspace.svg)](https://crates.io/crates/mikktspace) -[![Build Status](https://travis-ci.org/bwasty/mikktspace-rs.svg?branch=master)](https://travis-ci.org/bwasty/mikktspace-rs) +[![Build Status](https://travis-ci.org/bwasty/mikktspace-rs.svg?branch=master)](https://travis-ci.org/gltf-rs/mikktspace) -Rust MikkTSpace bindings +Bindings to the [Mikkelsen Tangent Space Algorithm] reference implementation. -## License agreement +### Examples + +#### generate + +Demonstrates generating tangents for a cube with 4 triangular faces per side. + +```sh +cargo run --example generate +``` + +There is also an equivalent C example to check the correctness of the Rust bindings. + +```sh +cd examples +cmake ../libmikktspace +make +cc generate.c libmikktspace.a -I../libmikktspace -lm -o generate +./generate +``` + +### License agreement Licensed under either of @@ -17,4 +37,6 @@ at your option. Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be -dual licensed as above, without any additional terms or conditions. \ No newline at end of file +dual licensed as above, without any additional terms or conditions. + +[Mikkelsen Tangent Space Algorithm]: (https://wiki.blender.org/index.php/Dev:Shading/Tangent_Space_Normal_Maps)