diff options
| author | Yuval Adam <_@yuv.al> | 2019-03-18 14:41:36 +0200 |
|---|---|---|
| committer | Yuval Adam <_@yuv.al> | 2019-03-18 14:41:36 +0200 |
| commit | 82388514aa38f632738e60337712dc036fc3dbb8 (patch) | |
| tree | df12f15b5f5465ef176e995c731172afdb0e7dd7 /README.md | |
| parent | 704dccd997146524848d0fd3900fc9832a18a742 (diff) | |
Add README and LICENSE
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..9c8d7b5 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# bchlib + + + +High-level Rust bindings for BCH encoding/decoding library, based on the [bch_codec](https://github.com/mborgerding/bch_codec) fork. + +The lower level library can be found at: https://github.com/yuvadm/bchlib-sys + +## Usage + +Add the library to your `Cargo.toml`: + +``` +[dependencies] +bchlib = "0.1.0" +``` + +## Build + +The usual: + +```bash +$ cargo build +$ cargo test +``` + +## License + +[GPLv2](LICENSE.md) |
