[libcamera-devel] [PATCH v3 27/27] gst: Document dependencies and quick usage

[Nicolas Dufresne]

From: Nicolas Dufresne <nicolas.dufresne at collabora.com>

This is a quick startup guide allowing to build and use the GStreamer element
from the libcamera source tree.

Signed-off-by: Nicolas Dufresne <nicolas.dufresne at collabora.com>
---
 README.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.rst b/README.rst
index fa14113..a06e444 100644
--- a/README.rst
+++ b/README.rst
@@ -64,4 +64,23 @@ for qcam: [optional]
 for documentation: [optional]
 	python3-sphinx doxygen
 
+for gstreamer: [optional]
+	libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev
+
+Using GStreamer plugin
+~~~~~~~~~~~~~~~~~~~~~~
+
+To use GStreamer plugin from source tree, set the following environment so that
+GStreamer can find it.
+
+  export GST_PLUGIN_PATH=$(pwd)/build/src/gstreamer
+
+The debugging tool `gst-launch-1.0` can be used to construct and pipeline and test
+it. The following pipeline will stream from the camera named "Camera 1" onto the
+default video display element on your system.
+
+.. code::
+
+  gst-launch-1.0 libcamerasrc name="Camera 1" ! videoconvert ! autovideosink
+
 .. section-end-getting-started
-- 
2.24.1