X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=README;h=8e1631301327307a5ca88c6d2e8397c7c9a4e4ec;hb=2487d58b3968e381a542c688a55a29a5f0c9f5a5;hp=fc7f3c5608c93d73639e1bd88528240b3f4019ce;hpb=092636b85449e57fd33ffd4954a2de23c2a5f81c;p=melted diff --git a/README b/README index fc7f3c5..8e16313 100644 --- a/README +++ b/README @@ -11,24 +11,28 @@ 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 - + modules - All components are defined here - + core - Non-dependent MLT service - + dv - libdv services - + ffmpeg - ffmpeg dependent modules and test code - + sdl - SDL dependent modules and test code - + bluefish - Bluefish dependent modules and test code (*) - + mainconcept - mainconcept 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. @@ -61,9 +65,21 @@ 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.