summaryrefslogtreecommitdiff
path: root/README.md
blob: c1d486adb394d990243ac931f1c32a07ad49db6e (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
# codec2.rs

Rust system bindings for the [codec2](https://github.com/drowe67/codec2) library.

Provides the following packages:
  - [`libcodec2`](libcodec2): safe and ergonomic wrappers around the core libcodec2 function calls
  - [`codec2-sys`](codec2-sys): unsafe low-level bindings, automagically generated via [bindgen](https://github.com/rust-lang/rust-bindgen)

Additionally, this repo includes [`c2enc`](c2enc) which is a demo CLI program that imitates the original `c2enc`.

This project is unrelated to the [`codec2`](https://github.com/scriptjunkie/codec2) crate which is a partial pure-rust implementation.

## Usage

Install with `cargo add`:

```bash
$ cargo add libcodec2
```

Or add manually to your `Cargo.toml`:

```
libcodec2 = "1.0.0"
```

## License

[LGPL-2.1](LICENSE)