forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source 
Former-commit-id: c5cf7e1494f3f9f288ae88d6fd21c66e03cd15d4
This commit is contained in:
David Harvey-Macaulay 2017-09-12 10:58:26 +01:00
parent a4b7821128
commit 18fab51991
1 changed files with 26 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,10 +1,30 @@
# mikktspace-rs # mikktspace-rs
[![crates.io](https://img.shields.io/crates/v/mikktspace.svg)](https://crates.io/crates/mikktspace) [![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 Licensed under either of
@ -17,4 +37,6 @@ at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted 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 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. 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)