From 131c2c103bb54ad666707aa129d62ba392119fab Mon Sep 17 00:00:00 2001 From: Zhiming Wang Date: Sun, 2 Aug 2020 11:47:18 +0800 Subject: [PATCH] README: add documentation links --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 2304e5d..acd94c8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ [![crates.io](https://img.shields.io/crates/v/ffmpeg-next.svg)](https://crates.io/crates/ffmpeg-next) +[![docs.rs](https://docs.rs/ffmpeg-next/badge.svg)](https://docs.rs/ffmpeg-next/) [![build](https://github.com/zmwangx/rust-ffmpeg/workflows/build/badge.svg)](https://github.com/zmwangx/rust-ffmpeg/actions) This is a fork of the abandoned [ffmpeg](https://crates.io/crates/ffmpeg) crate by [meh.](https://github.com/meh/rust-ffmpeg). @@ -7,6 +8,12 @@ Currently supported FFmpeg versions: 3.4.x through 4.3.x. Build instructions can be found on the [wiki](https://github.com/zmwangx/rust-ffmpeg/wiki/Notes-on-building). +Documentation: + +- [docs.rs](https://docs.rs/ffmpeg-next/); +- [FFmpeg user manual](https://ffmpeg.org/ffmpeg-all.html); +- [FFmpeg Doxygen](https://ffmpeg.org/doxygen/trunk/). + *Note on upgrading to v4.3.4 or later: v4.3.4 introduced automatic FFmpeg version detection, obseleting feature flags `ffmpeg4`, `ffmpeg41`, `ffmpeg42` and `ffmpeg43`. If you manually specify any of these features, now is the time to remove them; if you use `ffmpeg43` through the `default` feature, it's still on for backward-compatibility but it has turned into a no-op, and you don't need to do anything. Deprecation plan: `ffmpeg43` will be dropped from default features come 4.4, and all these features will be removed come 5.0.* A word on versioning: major and minor versions of this crate track major and minor versions of FFmpeg, e.g. 4.2.x of this crate has been updated to support the 4.2.x series of FFmpeg. Patch level is reserved for bug fixes of this crate and does not track FFmpeg patch versions.