git.sesse.net Git - mlt/blob - 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         This document provides a quick reference for the minimal configuration,
  11         build and installation of MLT. See the docs directory for usage and
  12         development details.
  13
  14 Configuration
  15 -------------
  16
  17         Configuration is triggered by running:
  18
  19             ./configure
  20
  21         Usage is:
  22
  23         ./configure --help                      - report all configure options
  24         ./configure --prefix=[dir]      - target install directory (default: /usr/local)
  25         ./configure --disable-[mod] - do not compile specified module(s)
  26         ./configure --[other]           - pass through to children
  27
  28         NB: This script must be run to register new services after a CVS checkout
  29         or subsequent update.
  30
  31 Compilation
  32 -----------
  33
  34         Once configured, it should be sufficient to run:
  35
  36             make
  37
  38         to compile the system.
  39
  40 Testing
  41 -------
  42
  43         To execute the mlt tools without installation, or to test a new version
  44         on a system with an already installed mlt version, you should run:
  45
  46             . setenv
  47
  48         NB: This applies to your current shell only and it assumes a bash or
  49         regular bourne shell is in use.
  50
  51 Installation
  52 ------------
  53
  54         The install is triggered by running:
  55
  56             make install
  57
  58
  59 More Information
  60 ----------------
  61
  62         For more detailed information, please refer to docs/install.txt.