X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=README;h=8e1631301327307a5ca88c6d2e8397c7c9a4e4ec;hb=2487d58b3968e381a542c688a55a29a5f0c9f5a5;hp=6ed3c5f6d3000dad8975393e62f0de2603e73dae;hpb=4ed2712bbdac2182c7c0d6477ac77c9f92aaf02a;p=melted

diff --git a/README b/README
index 6ed3c5f..8e16313 100644
--- a/README
+++ b/README
@@ -11,23 +11,30 @@ Directories
 
 	The directory heirarchy is defined as follows:
 
-	+ docs					- Location of all text and source format 
-							  documentation
+	+ docs					- Location of all documentation
 	+ src					- All project source is provided here
-		+ framework			- The media framework - this code is 100% posix
-							  and as such contain no implementations 
-							  requiring additional libraries
-		+ modules			- All components are defined here with a 
-							  subdirectory for each dependency
-			+ bluefish		- Bluefish dependent modules and test code
-			+ ffmpeg		- ffmpeg dependent modules and test code
-			+ mainconcept	- mainconcept dependent modules and test code
-			+ SDL			- SDL dependent modules and test code
+		+ framework			- The mlt media framework
+		+ modules			- All services are defined here
+			+ core			- Independent MLT services
+			+ dv			- libdv dependent services
+			+ ffmpeg		- ffmpeg dependent services
+			+ avformat		- libavformat dependent services
+			+ sdl			- SDL dependent services
+			+ resample		- libresample dependent services
+			+ gtk2			- pango and pixbuf dependent services
+			+ 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
+		+ humperdink		- The evil demo
+		+ albino			- The simple but nice demo
+		+ tests				- Reserved for regression and unit tests
 
 	Additional subdirectories may be nested below those shown and should be
-	documented in their parent or here.
+	documented in their parent.
+
+	(*) Not posted to CVS due to licensing issues.
 
 Configuration
 -------------
@@ -49,15 +56,30 @@ Configuration
 	./configure --disable-[mod] - do not compile specified module(s)
 	./configure --[other]		- pass through to children
 
+	NB: This script must be run to register new services after a CVS checkout
+	or subsequent update.
+	
 Compilation
 -----------
 
 	Makefiles are generated during configuration and these are based on
 	a per directory template which must be provided by the developer.
 
+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.
+
 Installation
 ------------
 
+	* NOT IMPLEMENTED YET *
+
 	The install is triggered by running make install or make install-strip
 	from the top level directory.
 	
@@ -73,9 +95,9 @@ Installation
 	$prefix/bin/. This is linked against the framework shared object and
 	posix libs but not against any of the modules.
 
-	The modules produce a shared object per module and a text file containing
-	a list of modules provided by this build. These are installed in
-	$prefix/share/mlt/. It is at the discretion of the module to install
+	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/. It is at the discretion of the module to install
 	additional support files. 
 	
 	To allow the development of external components, mlt-client-config and
@@ -102,8 +124,8 @@ Development
 
 		#include <framework/file.h>
 
-	This allows migration of source between external and internal
-	modules. The configuration and Makefile template requirements will require
+	This allows migration of source between external and internal modules. 
+	The configuration and Makefile template requirements will require
 	attention though.
 
 Summary