MLT/Miracle README
------------------

	Sponsored by Ushodaya Enterprises Limited
	Written by Charles Yates <charles.yates@pandora.be>
	and Dan Dennedy <dan@dennedy.org>

	MLT is a LGPL multimedia framework designed for television broadcasting,
	and Miracle is a GPL multi-unit video playout server with realtime
	effects.

	This document provides a quick reference for the minimal configuration,
	build and installation of MLT. See the docs directory for usage and
	development details.


Configuration
-------------

	Configuration is triggered by running:

	    ./configure 

	More information on usage is found by running:

	    ./configure --help

	NB: This script must be run to register new services after a CVS checkout
	or subsequent update.


Compilation
-----------

	Once configured, it should be sufficient to run:

	    make

	to compile the system.


Testing
-------

	To execute the mlt tools without installation, or to test a new version
	on a system with an already installed mlt version, you should run:

	    . setenv

	NB: This applies to your current shell only and it assumes a bash or 
	regular bourne shell is in use.


Installation
------------

	The install is triggered by running:
	
	    make install 
	

More Information
----------------

	For more detailed information, please refer to docs/install.txt.
