diff options
| author | Yuval Adam <_@yuv.al> | 2019-05-27 10:40:46 +0300 |
|---|---|---|
| committer | Yuval Adam <_@yuv.al> | 2019-05-27 10:40:46 +0300 |
| commit | a98b1bea816b7f56c70564e73cea5f40c5139c16 (patch) | |
| tree | 5358543a3bb6768c5d7aef10fef0e6b7914c4004 | |
| parent | c0ae27fa2dd6bb9a5692330f00c844b92e912853 (diff) | |
Cleanup READMEs
| -rw-r--r-- | README.md | 31 | ||||
| -rw-r--r-- | bchlib-sys/README.md | 31 | ||||
| -rw-r--r-- | bchlib/README.md | 29 |
3 files changed, 31 insertions, 60 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..cdab8d3 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# bchlib + + + +Rust bindings for BCH encoding/decoding library, based on the [bch_codec](https://github.com/mborgerding/bch_codec) fork. + +This workspace repo contains both the high-level `bchlib` project as well as the lower-level `bchlib-sys` project that builds the original C library. + +## Usage + +Add the library to your `Cargo.toml`: + +``` +[dependencies] +bchlib = "0.1.0" +``` + +## Build + +The usual: + +```bash +$ cargo build +$ cargo test +``` + +Note that due to usage of `bindgen` in the lower level `bchlib-sys` project, you will need `clang` to be installed on your system. + +## License + +[GPLv2](LICENSE.md) diff --git a/bchlib-sys/README.md b/bchlib-sys/README.md deleted file mode 100644 index 1325e75..0000000 --- a/bchlib-sys/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# 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) diff --git a/bchlib/README.md b/bchlib/README.md deleted file mode 100644 index 9c8d7b5..0000000 --- a/bchlib/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# 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) |