summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMathieu Duponchelle <mathieu@centricular.com>2018-10-29 14:00:31 +0100
committerWim Taymans <wim.taymans@gmail.com>2018-10-29 13:26:46 +0000
commit8693e416bc8208af8132391800b4ae023f0b0740 (patch)
tree674dd8e17085469de028790d0b949d15bf8ae171
parent68c2866f7d5a6965339eaf287c54616d2270c2b2 (diff)
examples: document how to run
-rw-r--r--src/examples/README19
1 files changed, 19 insertions, 0 deletions
diff --git a/src/examples/README b/src/examples/README
new file mode 100644
index 00000000..ef545b36
--- /dev/null
+++ b/src/examples/README
@@ -0,0 +1,19 @@
+# Running the examples
+
+A pipewire daemon needs to be running for the examples to connect to:
+
+``` shell
+./pw-uninstalled.sh
+./build/src/daemon/pipewire
+```
+
+You can then run the examples in a second terminal, for example:
+
+``` shell
+./pw-uninstalled.sh
+./build/src/examples/local-v4l2
+```
+
+This assumes the development package for `SDL2` was installed, check the meson
+build definition in `src/examples` to find out the dependencies for each
+example.