]> git.sesse.net Git - mlt/blobdiff - docs/install.txt
Set version to 0.8.4
[mlt] / docs / install.txt
index 3e7ac088f23d8453cbe0bb04129bdbf8faea3cea..b87add604af02624f82db4da5d1739ac80f5b701 100644 (file)
@@ -1,8 +1,8 @@
 Installation Documentation
 
-Copyright (C) 2004 Ushodaya Enterprises Limited
+Copyright (C) 2004-2009 Ushodaya Enterprises Limited
 Author: Charles Yates <charles.yates@pandora.be>
-Last Revision: 2004-04-13
+Last Revision: 2009-05-08
 
 
 INSTALL
@@ -22,31 +22,25 @@ Directories
        + src                   - All project source is provided here
            + framework         - The mlt media framework
            + modules           - All services are defined here
+               + avformat      - libavformat dependent services
                + core          - Independent MLT services
                + dv            - libdv dependent services
-               + ffmpeg        - ffmpeg dependent services
-               + avformat      - libavformat dependent services
-               + vorbis        - vorbis dependenent services
-               + sdl           - SDL dependent services
-               + resample      - libresample dependent services
                + gtk2          - pango and pixbuf dependent services
-               + fezzik        - A giant (meta) service to load and normalise media
-               + westley       - Nice and clever XML services
-               + vorbis        - Ogg Vorbis dependent services
-               + xine          - Xine-derived sources
-               + bluefish      - Bluefish dependent services (*)
-               + mainconcept   - mainconcept dependent services (*)
-           + inigo             - A media playing test application
-           + valerie           - Client API to access the server
-           + miracle           - The server implementation
-           + albino            - A simple console (protocol level) example
-           + humperdink        - A terminal-based example client
+               + normalize     - audio normalisation functions (**)
+               + plus          - throwaway silliness
+               + resample      - libresample dependent services (**)
+               + sdl           - SDL dependent services
+               + vorbis        - vorbis dependenent services
+               + xml           - XML (de)serialization services
+               + xine          - Xine-derived sources (**)
+           + melt              - A media playing test application (**)
            + tests             - Reserved for regression and unit tests
 
        Additional subdirectories may be nested below those shown and should be
        documented in their parent.
 
-       (*) Not posted to CVS due to licensing issues.
+       (*)  Not posted to CVS due to licensing issues.
+       (**) Contains GPL dependencies or code.
 
 
 Dependencies
@@ -68,20 +62,14 @@ Dependencies
        avformat    Provided from ffmpeg CVS and compiled as a shared library.
                    URL: http://ffmpeg.sf.net
        ----------- ----------------------------------------------------------
-       bluefish    Bluefish hardware and software development kit
-                   URL: http://www.bluefish444.com
-       ----------- ----------------------------------------------------------
        dv          libdv 0.102 or later.
                    URL: http://libdv.sf.net
        ----------- ----------------------------------------------------------
        gtk2        GTK2 and associated dependencies.
                    URL: http://www.gtk.org
        ----------- ----------------------------------------------------------
-       mainconcept Mainconcept MPEG and DVCPRO Release SDKs.
-                   URL: http://www.mainconcept.com
-       ----------- ----------------------------------------------------------
        resample    libsamplerate 0.15 or later 
-                   URL: http://www.mega-nerd.com/SRC/
+                   URL: http://www.mega-nerd.com/SRC/ (GPL)
        ----------- ----------------------------------------------------------
        sdl         SDL 1.2 or later.
                    URL: http://www.libsdl.org
@@ -89,7 +77,7 @@ Dependencies
        vorbis      libvorbis 1.0.1 or later.
                    URL: http://www.vorbis.com/
        ----------- ----------------------------------------------------------
-       westley     libxml2 2.5 or later.
+       xml         libxml2 2.5 or later.
                    URL: http://www.xmlsoft.org/
        ----------- ----------------------------------------------------------
 
@@ -107,15 +95,9 @@ Configuration
        configure script and arguments are accepted and passed through to all 
        subdirectories.
 
-       Top level usage is:
+       More information on usage is found by running:
 
-       ./configure --help          - report all configure options
-       ./configure --prefix=[dir]  - target install directory (default: /usr/local)
-       ./configure --disable-debug - turn off debugging
-       ./configure --disable-mmx   - turn off MMX usage
-       ./configure --cpu='cpu'     - tune build for a specific cpu
-       ./configure --disable-[mod] - do not compile specified module(s)
-       ./configure --[other]       - pass through to children
+           ./configure --help
 
        NB: This script must be run to register new services after a CVS checkout
        or subsequent update.
@@ -149,14 +131,6 @@ Installation
        $prefix/lib/ and public header files which are installed in
        $prefix/include/mlt/framework.
 
-       Valerie produces a single shared object which is installed in 
-       $prefix/lib/ and public header which are installed in 
-       $prefix/include/mlt/valerie.
-
-       Miracle produces a single exectuable which is installed in
-       $prefix/bin/, a library in $prefix/lib and associated header files in
-       $prefix/include.
-
        The modules produce a shared object per module and update text files
        containing a list of modules provided by this build. These are installed 
        in $prefix/share/mlt/modules. It is at the discretion of the module to