summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEdward Hervey <edward@centricular.com>2020-05-12 17:20:33 +0200
committerEdward Hervey <bilboed@bilboed.com>2020-05-12 17:28:11 +0200
commitc6d2c44e2c28a7ff67648d9aa68363f0f76d0e70 (patch)
tree217c6272deb52b30d31439b7d52cb3588e906251
parent581abbd4cc45dc4cd8a7d971349ea09002c3959a (diff)
README: Convert to markdown
Same thing as previously, with some links updated and removal of mention of autotools.
-rw-r--r--README50
-rw-r--r--README.md55
2 files changed, 55 insertions, 50 deletions
diff --git a/README b/README
deleted file mode 100644
index 392cad9..0000000
--- a/README
+++ /dev/null
@@ -1,50 +0,0 @@
-This git module contains template code for possible GStreamer projects.
-
-gst-app
- basic autotools layout for writing a GStreamer-based application.
-
-gst-plugin
- basic autotools layout and basic filter code for writing a
- GStreamer plug-in.
-
-This code is provided under a MIT license [1], which basically means "do
-with it as you wish, but don't blame us if it doesn't work". You can use
-this code for any project as you wish, under any license as you wish. We
-recommend the use of the LGPL [2] license for applications and plugins,
-given the minefield of patents the multimedia is nowadays. See our website
-for details [3].
-
-Build each module like this:
-
- cd gst-plugin
- meson builddir
- ninja -C builddir
-
-See https://mesonbuild.com/Quick-guide.html on how to install the Meson
-build system and ninja.
-
-Modify gst-plugin/meson.build to add or remove source files to build or
-add additional dependencies or compiler flags or change the name of the
-plugin file to be installed.
-
-Modify meson.build to check for additional library dependencies
-or other features needed by your plugin.
-
-Once the plugin is built you can either install it with `sudo ninja -C builddir install`
-(however, this will by default go into the /usr/local prefix where it won't
-be picked up by a GStreamer installed from packages, so you would need to
-set the GST_PLUGIN_PATH environment variable to include or point to
-/usr/local/lib/gstreamer-1.0/ for your plugin to be found by a from-package
-GStreamer). Alternatively, you will find your plugin binary in
-builddir/gst-plugins/src/ as libgstplugin.so or similar (the extension may vary),
-so you can also set the GST_PLUGIN_PATH environmen variable to the
-builddir/gst-plugins/src/ directory (best to specify an absolute path though).
-
-You can also check if it has been built correctly with:
-
- gst-inspect-1.0 builddir/gst-plugins/src/libgstplugin.so
-
-
-[1] http://www.opensource.org/licenses/mit-license.php or COPYING.MIT
-[2] http://www.opensource.org/licenses/lgpl-license.php or COPYING.LIB
-[3] http://gstreamer.freedesktop.org/documentation/licensing.html
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d552c97
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+# GStreamer template repository
+
+This git module contains template code for possible GStreamer projects.
+
+* gst-app :
+ basic meson-based layout for writing a GStreamer-based application.
+
+* gst-plugin :
+ basic meson-based layout and basic filter code for writing a GStreamer plug-in.
+
+## License
+
+This code is provided under a MIT license [MIT], which basically means "do
+with it as you wish, but don't blame us if it doesn't work". You can use
+this code for any project as you wish, under any license as you wish. We
+recommend the use of the LGPL [LGPL] license for applications and plugins,
+given the minefield of patents the multimedia is nowadays. See our website
+for details [Licensing].
+
+## Usage
+
+Configure and build all examples (application and plugins) as such:
+
+ meson builddir
+ ninja -C builddir
+
+See <https://mesonbuild.com/Quick-guide.html> on how to install the Meson
+build system and ninja.
+
+Modify `gst-plugin/meson.build` to add or remove source files to build or
+add additional dependencies or compiler flags or change the name of the
+plugin file to be installed.
+
+Modify `meson.build` to check for additional library dependencies
+or other features needed by your plugin.
+
+Once the plugin is built you can either install system-wide it with `sudo ninja
+-C builddir install` (however, this will by default go into the `/usr/local`
+prefix where it won't be picked up by a `GStreamer` installed from packages, so
+you would need to set the `GST_PLUGIN_PATH` environment variable to include or
+point to `/usr/local/lib/gstreamer-1.0/` for your plugin to be found by a
+from-package `GStreamer`).
+
+Alternatively, you will find your plugin binary in `builddir/gst-plugins/src/`
+as `libgstplugin.so` or similar (the extension may vary), so you can also set
+the `GST_PLUGIN_PATH` environment variable to the `builddir/gst-plugins/src/`
+directory (best to specify an absolute path though).
+
+You can also check if it has been built correctly with:
+
+ gst-inspect-1.0 builddir/gst-plugins/src/libgstplugin.so
+
+[MIT]: http://www.opensource.org/licenses/mit-license.php or COPYING.MIT
+[LGPL]: http://www.opensource.org/licenses/lgpl-license.php or COPYING.LIB
+[Licensing]: https://gstreamer.freedesktop.org/documentation/application-development/appendix/licensing.html