summaryrefslogtreecommitdiff
path: root/doc/examples/README
diff options
context:
space:
mode:
Diffstat (limited to 'doc/examples/README')
-rw-r--r--doc/examples/README23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/examples/README b/doc/examples/README
new file mode 100644
index 0000000000..c1ce619d35
--- /dev/null
+++ b/doc/examples/README
@@ -0,0 +1,23 @@
+FFmpeg examples README
+----------------------
+
+Both following use cases rely on pkg-config and make, thus make sure
+that you have them installed and working on your system.
+
+
+Method 1: build the installed examples in a generic read/write user directory
+
+Copy to a read/write user directory and just use "make", it will link
+to the libraries on your system, assuming the PKG_CONFIG_PATH is
+correctly configured.
+
+Method 2: build the examples in-tree
+
+Assuming you are in the source FFmpeg checkout directory, you need to build
+FFmpeg (no need to make install in any prefix). Then just run "make examples".
+This will build the examples using the FFmpeg build system. You can clean those
+examples using "make examplesclean"
+
+If you want to try the dedicated Makefile examples (to emulate the first
+method), go into doc/examples and run a command such as
+PKG_CONFIG_PATH=pc-uninstalled make.