insert fix
[melted] / README
1 MLT/Miracle README
2 ------------------
3
4         Copyright (C) 2003-2004 Ushodaya Enterprises Limited
5         by Charles Yates <charles.yates@pandora.be>
6         and Dan Dennedy <dan@dennedy.org>
7
8         MLT is a multimedia framework designed for television broadcasting, and 
9         Miracle is a multi-unit video playout server with realtime effects.
10
11         This document provides a quick reference for the minimal configuration,
12         build and installation of MLT. See the docs directory for usage and
13         development details.
14
15
16 Configuration
17 -------------
18
19         Configuration is triggered by running:
20
21             ./configure 
22
23         Usage is:
24
25         ./configure --help          - report all configure options
26         ./configure --prefix=[dir]  - target install directory (default: /usr/local)
27         ./configure --disable-[mod] - do not compile specified module(s)
28         ./configure --[other]       - pass through to children
29
30         NB: This script must be run to register new services after a CVS checkout
31         or subsequent update.
32
33
34 Compilation
35 -----------
36
37         Once configured, it should be sufficient to run:
38
39             make
40
41         to compile the system.
42
43
44 Testing
45 -------
46
47         To execute the mlt tools without installation, or to test a new version
48         on a system with an already installed mlt version, you should run:
49
50             . setenv
51
52         NB: This applies to your current shell only and it assumes a bash or 
53         regular bourne shell is in use.
54
55
56 Installation
57 ------------
58
59         The install is triggered by running:
60         
61             make install 
62         
63
64 More Information
65 ----------------
66
67         For more detailed information, please refer to docs/install.txt.