diff --git a/sys/Cargo.toml b/sys/Cargo.toml index b14675b..04fa962 100644 --- a/sys/Cargo.toml +++ b/sys/Cargo.toml @@ -3,7 +3,7 @@ name = "ffmpeg-sys" version = "4.0.2" build = "build.rs" links = "ffmpeg" - +readme = "README.md" authors = ["meh. "] license = "WTFPL" diff --git a/sys/README.md b/sys/README.md new file mode 100644 index 0000000..6ad0ef2 --- /dev/null +++ b/sys/README.md @@ -0,0 +1,19 @@ +# Rust FFI bindings for ffmpeg + +Low-level bindings for ffmpeg autogenerated with bindgen. This crate supports cross-compilation automatically. + +For higher-level library, see [ffmpeg crate](https://lib.rs/ffmpeg). + +## Building + +By default, the crate will search for ffmpeg v4 installed on the system. + +This crate can also download, build and statically link its own copy of ffmpeg if you enable `build` feature: + +```toml +[dependencies] +ffmpeg-sys = { version = "4", features = ["build"] } +``` + +See [Cargo features](https://github.com/meh/rust-ffmpeg/blob/HEAD/Cargo.toml) to control which codecs are included. +