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

[Clément Bœsch]

On Thu, Sep 13, 2012 at 09:13:36PM +0200, Stefano Sabatini wrote:
> ---
>  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

Should we deploy this file in the installation as well?

> @@ -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
> +

If my question above is answered positively, I would propose two sections:

 - "Build the installed examples in your copy":
        cp to a r/w user directory and just use "make", it will link to
        the libraries on your system, assuming the PKG_CONFIG_PATH is
        correctly configured

 - "Build the examples in-tree"
        you need a ffmpeg built, no need to make install in any prefix,
        and use PKG_CONFIG_PATH=pc-uninstalled prefix for make)

Would that make any sense?

-- 
Clément B.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 490 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20120913/21e3d350/attachment.asc>