[FFmpeg-devel] [PATCH] examples: add README file with simple compilation instructions

[Stefano Sabatini]

---
 doc/examples/README |   29 +++++++++++++++++++++++++++++
 1 files changed, 29 insertions(+), 0 deletions(-)
 create mode 100644 doc/examples/README

diff --git a/doc/examples/README b/doc/examples/README
new file mode 100644
index 0000000..9528b61
--- /dev/null
+++ b/doc/examples/README
@@ -0,0 +1,29 @@
+FFmpeg examples README
+----------------------
+
+In order to compile the example programs contained in this directory,
+you need an updated installation of the FFmpeg libraries, and you need
+to setup the PKG_CONFIG_PATH variable to point to the installed
+pkgconfig file.
+
+For example, supposing you installed FFmpeg in /usr/local/, you'll
+need to set PKG_CONFIG_PATH to "/usr/local/lib/pkgconfig", for example
+typing the command:
+
+$ export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig
+
+Finally you can compile the example programs with the command:
+
+$ make
+
+If you didn't install FFmpeg or you want to build the examples against
+the libraries compiled in the source tree, you can make
+PKG_CONFIG_PATH points to the pkgconfig files in the directory
+pc-uninstalled/, for example running the command:
+
+$ env PKG_CONFIG_PATH=pc-uninstalled make
+
+To remove the generated files you can run the command:
+
+$ make clean
+
-- 
1.7.5.4