README: Convert to markdown, clarify licensing
authorNirbheek Chauhan <nirbheek@centricular.com>
Thu, 30 Apr 2020 12:42:19 +0000 (18:12 +0530)
committerNirbheek Chauhan <nirbheek@centricular.com>
Thu, 30 Apr 2020 12:42:19 +0000 (18:12 +0530)
Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-libav/-/merge_requests/68>

README [deleted file]
README.md [new file with mode: 0644]

diff --git a/README b/README
deleted file mode 100644 (file)
index 4f69c2e..0000000
--- a/README
+++ /dev/null
@@ -1,16 +0,0 @@
-gst-ffmpeg
-
-This module contains a GStreamer plugin for FFmpeg.
-
-PLUG-IN DEPENDENCIES AND LICENSES
----------------------------------
-
-GStreamer is developed under the terms of the LGPL (see LICENSE file for
-details). Some of our plug-ins however rely on libraries which are available
-under other licenses. This means that if you are distributing an application
-which has a non-GPL compatible license (for instance a closed-source
-application) with GStreamer, you have to make sure not to distribute GPL-linked
-plug-ins.
-
-When using GPL-linked plug-ins, GStreamer is for all practical reasons
-under the GPL itself.
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..15e40f1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# gst-libav
+
+This module contains a GStreamer plugin for using the encoders, decoders,
+muxers, and demuxers provided by FFmpeg. It is called gst-libav for historical
+reasons.
+
+# Plugin Dependencies and Licenses
+
+GStreamer is developed under the terms of the LGPL-2.1 (see COPYING file for
+details), and that includes the code in this repository.
+
+However, this repository depends on FFmpeg, which can be built in the following
+modes using various `./configure` switches: LGPL-2.1, LGPL-3, GPL, or non-free.
+
+This can mean, for example, that if you are distributing an application which
+has a non-GPL compatible license (like a closed-source application) with
+GStreamer, you have to make sure not to build FFmpeg with GPL code enabled.
+
+Overall, when using plugins that link to GPL libraries, GStreamer is for all
+practical reasons under the GPL itself.
+
+The above recommendations are not legal advice, and you are responsible for
+ensuring that you meet your licensing obligations.