X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=docs%2Finstall.txt;h=b8883229cdbbab0e55108fe1b9b2a70d21ec1b58;hb=84425c1be5307863eea88f29e285df38026b6984;hp=e4b3b8dfb825eff6c8dd58bdf7762dee4f7c93c9;hpb=a83b8624f7a504b52e6432e049df69f41cc9ce75;p=melted

diff --git a/docs/install.txt b/docs/install.txt
index e4b3b8d..b888322 100644
--- a/docs/install.txt
+++ b/docs/install.txt
@@ -1,12 +1,16 @@
+Installation Documentation
+
+Copyright (C) 2004 Ushodaya Enterprises Limited
+Author: Charles Yates <charles.yates@pandora.be>
+Last Revision: 2004-04-13
+
+
 INSTALL
 -------
 
 	This document provides a description of the MLT project installation and
 	organisation.
 
-	It provides *CRITICAL* architecture information, so please read carefully
-	if you plan to extend or use the MLT code base.
-
 
 Directories
 -----------
@@ -18,31 +22,77 @@ Directories
 	+ src                   - All project source is provided here
 	    + framework         - The mlt media framework
 	    + modules           - All services are defined here
+	        + avformat      - libavformat dependent services
+	        + bluefish      - Bluefish 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 (*)
+	        + gtk2          - pango and pixbuf 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
+	        + westley       - Nice and clever XML services
+	        + xine          - Xine-derived sources (**)
+	    + albino            - A simple console (protocol level) example (**)
+	    + inigo             - A media playing test application (**)
+	    + humperdink        - A terminal-based example client (**)
+	    + miracle           - The server implementation (**)
 	    + tests             - Reserved for regression and unit tests
+	    + valerie           - Client API to access the server
 
 	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
+------------
+
+	The MLT core is dependent on:
+
+	* a C99 compliant C compiler
+	* posix threading
+	* standard posix libraries
+
+	The MLT applications and libraries provided are all dependent on the core.
+
+	The modules have the following dependencies:
+
+	----------- ----------------------------------------------------------
+	MODULE      DESCRIPTION
+	----------- ----------------------------------------------------------
+	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/ (GPL)
+	----------- ----------------------------------------------------------
+	sdl         SDL 1.2 or later.
+	            URL: http://www.libsdl.org
+	----------- ----------------------------------------------------------
+	vorbis      libvorbis 1.0.1 or later.
+	            URL: http://www.vorbis.com/
+	----------- ----------------------------------------------------------
+	westley     libxml2 2.5 or later.
+	            URL: http://www.xmlsoft.org/
+	----------- ----------------------------------------------------------
 
 
 Configuration
@@ -58,12 +108,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-[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.
@@ -84,7 +131,7 @@ Testing
 
 	. setenv
 
-	NB: This applies to your current shell only.
+	NB: This applies to your current shell only and it assumes sh or bash.
 
 
 Installation