aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2012-09-13 21:12:56 +0200
committerStefano Sabatini <stefasab@gmail.com>2012-10-16 13:34:48 +0200
commit7ca102a7d7bd610f66ceb1256c3cb600091c8cda (patch)
tree08f2769f3f297b834f003168ba19bcbc6c02ee94
parentd15be9108e6a17e6fdc224fb8cd2640b825dd408 (diff)
downloadffmpeg-7ca102a7d7bd610f66ceb1256c3cb600091c8cda.tar.gz
examples: add README file with simple compilation instructions
-rw-r--r--Makefile2
-rw-r--r--doc/examples/README18
2 files changed, 19 insertions, 1 deletions
diff --git a/Makefile b/Makefile
index 303f80fa9d..0abb300d82 100644
--- a/Makefile
+++ b/Makefile
@@ -41,7 +41,7 @@ FFLIBS-$(CONFIG_SWSCALE) += swscale
FFLIBS := avutil
DATA_FILES := $(wildcard $(SRC_PATH)/presets/*.ffpreset) $(SRC_PATH)/doc/ffprobe.xsd
-EXAMPLES_FILES := $(wildcard $(SRC_PATH)/doc/examples/*.c) $(SRC_PATH)/doc/examples/Makefile
+EXAMPLES_FILES := $(wildcard $(SRC_PATH)/doc/examples/*.c) $(SRC_PATH)/doc/examples/Makefile $(SRC_PATH)/doc/examples/README
SKIPHEADERS = cmdutils_common_opts.h
diff --git a/doc/examples/README b/doc/examples/README
new file mode 100644
index 0000000000..a4618139e1
--- /dev/null
+++ b/doc/examples/README
@@ -0,0 +1,18 @@
+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.
+
+
+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.
+
+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 you can go into the
+doc/examples and run a command such as PKG_CONFIG_PATH=pc-uninstalled make.