summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLuca Barbato <lu_zero@gentoo.org>2014-08-12 19:34:47 +0200
committerLuca Barbato <lu_zero@gentoo.org>2014-08-16 00:49:22 +0200
commit96ce6d6f119a16e489941c629a2805204322b717 (patch)
treec79434998c19968c30a849f9c3c775e3e5a5b508 /README.md
parent4b1f5e5090abed6c618c8ba380cd7d28d140f867 (diff)
downloadffmpeg-96ce6d6f119a16e489941c629a2805204322b717.tar.gz
doc: Add more information in the README
And convert it to Markdown.
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..2dc668a24d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+Libav
+=====
+
+Libav is a collection of libraries and tools to process multimedia content
+such as audio, video, subtitles and related metadata.
+
+## Libraries
+
+* `libavcodec` provides implementation of a wider range of codecs.
+* `libavformat` implements streaming protocols, container formats and basic I/O access.
+* `libavutil` includes hashers, decompressors and miscellaneous utility functions.
+* `libavfilter` provides a mean to alter decoded Audio and Video through chain of filters.
+* `libavdevice` provides an abstraction to access capture and playback devices.
+* `libavresample` implements audio mixing and resampling routines.
+* `libswscale` implements color conversion and scaling routines.
+
+## Tools
+
+* [avconv](http://libav.org/avconv.html) is a command line toolbox to
+ manipulate, convert and stream multimedia content.
+* [avplay](http://libav.org/avplay.html) is a minimalistic multimedia player.
+* [avprobe](http://libav.org/avprobe.html) is a simple analisys tool to inspect
+ multimedia content.
+* Additional small tools such as `aviocat`, `ismindex` and `qt-faststart`.
+
+## Documentation
+
+The offline documentation is available in the **doc/** directory.
+
+The online documentation is available in the main [website](http://libav.org)
+and in the [wiki](http://wiki.libav.org).
+
+### Examples
+
+Conding examples are available in the **doc/example** directory.
+
+## License
+
+Libav codebase is mainly LGPL-licensed with optional components licensed under
+GPL. Please refer to the LICENSE file for detailed information.