diff options
Diffstat (limited to 'bchlib-sys/README.md')
| -rw-r--r-- | bchlib-sys/README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/bchlib-sys/README.md b/bchlib-sys/README.md new file mode 100644 index 0000000..1325e75 --- /dev/null +++ b/bchlib-sys/README.md @@ -0,0 +1,31 @@ +# bchlib-sys + + + +Low-level Rust bindings for BCH encoding/decoding library, based on the [bch_codec](https://github.com/mborgerding/bch_codec) fork. + +The higher level library can be found at: https://github.com/yuvadm/bchlib + +## Usage + +Add the library to your `Cargo.toml`: + +``` +[dependencies] +bchlib-sys = "0.1.0" +``` + +## Build + +The usual: + +```bash +$ cargo build +$ cargo test +``` + +Note that due to usage of `bindgen` you will need `clang` to be installed on your system. + +## License + +[GPLv2](LICENSE.md) |