qmlgl: add README.md with information on building for non-linux platforms with qmake
authorGeorge Kiagiadakis <george.kiagiadakis@collabora.com>
Mon, 21 Jan 2019 09:53:53 +0000 (11:53 +0200)
committerGeorge Kiagiadakis <george.kiagiadakis@collabora.com>
Mon, 21 Jan 2019 09:55:50 +0000 (11:55 +0200)
ext/qt/README.md [new file with mode: 0644]

diff --git a/ext/qt/README.md b/ext/qt/README.md
new file mode 100644 (file)
index 0000000..c33eb43
--- /dev/null
@@ -0,0 +1,50 @@
+# Building for non-linux platforms
+
+Compiling the gstqmlgl plugin for non-linux platforms is not so trivial.
+This file explains the steps that need to be followed for a successful build.
+
+## Step 1
+
+Build GStreamer for the target platform using cerbero.
+
+## Step 2
+
+Enter the cerbero shell:
+```
+./cerbero-uninstalled -c config/<target platform config>.cbc shell
+```
+
+## Step 3
+
+Export the following environment variables:
+```
+export PATH=/path/to/Qt/<version>/<platform>/bin:$PATH
+```
+
+if you are cross-compiling (ex. for android), also export:
+```
+export PKG_CONFIG_SYSROOT_DIR=/
+```
+
+Additionally, if you are building for android:
+```
+export ANDROID_NDK_ROOT=$ANDROID_NDK
+```
+
+**Note**: the ANDROID_NDK variable is set by the cerbero shell; if you are not
+using this shell, set it to the directory where you have installed the android
+NDK. Additionally, if you are not building through the cerbero shell, it is also
+important to have set PKG_CONFIG_LIBDIR to $GSTREAMER_ROOT/lib/pkgconfig.
+
+## Step 4
+
+cd to the directory of the gstqmlgl plugin and run:
+```
+qmake .
+make
+```
+
+## Step 5
+
+Copy the built plugin to your $GSTREAMER_ROOT/lib/gstreamer-1.0 or link to it
+directly if it is compiled statically