From: Luca Barbato <lu_zero@gentoo.org>
Date: Tue, 12 Aug 2014 17:34:47 +0000 (+0200)
Subject: doc: Add more information in the README
X-Git-Tag: v11_beta1~4
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=96ce6d6f119a16e489941c629a2805204322b717;p=platform%2Fupstream%2Flibav.git

doc: Add more information in the README

And convert it to Markdown.
---

diff --git a/README b/README
deleted file mode 100644
index afef67161..000000000
--- a/README
+++ /dev/null
@@ -1,12 +0,0 @@
-Libav README
-------------
-
-1) Documentation
-----------------
-
-* Read the documentation in the doc/ directory.
-
-2) Licensing
-------------
-
-* See the LICENSE file.
diff --git a/README b/README
new file mode 120000
index 000000000..42061c01a
--- /dev/null
+++ b/README
@@ -0,0 +1 @@
+README.md
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..2dc668a24
--- /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.