summaryrefslogtreecommitdiff
path: root/bchlib-sys/README.md
blob: 1325e75a25b8ce04a1745c2013ebf3e65151c9b7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# bchlib-sys

![Crates.io](https://img.shields.io/crates/v/bchlib-sys.svg)

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)