summaryrefslogtreecommitdiff
path: root/bchlib-sys/README.md
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2019-05-27 10:32:18 +0300
committerYuval Adam <_@yuv.al>2019-05-27 10:32:18 +0300
commit186154550428c336ff9419ec4ed9ae11fb19c939 (patch)
tree86d4b50efc80460bd4f2f5362b78da7d6eb745b6 /bchlib-sys/README.md
parent7477bc29cfb6305f5e48a5f11f28e1384ca9f15b (diff)
Move all bchlib-sys files into bchlib-sys/
Diffstat (limited to 'bchlib-sys/README.md')
-rw-r--r--bchlib-sys/README.md31
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
+
+![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)