Class rework and simplification

[melted] / mlt++ / README

diff --git a/mlt++/README b/mlt++/README
index f4e8bed..d6d1b1c 100644 (file)
--- a/mlt++/README
+++ b/mlt++/README
@@ -15,8 +15,17 @@ USAGE
 
        Use the following definitions in a Makefile to compile and link with mlt++:
 
-       CXXFLAGS=`mlt-config -Wall`
-       LDFLAGS=-lmlt++
+               CXXFLAGS=`mlt-config -Wall`
+               LDFLAGS=-lmlt++
+
+       Include files for the classes can either be explicitly included, ie:
+
+               #include <mlt++/MltProducer.h>
+               etc
+
+       Or you can include all using:
+
+               #include <mlt++/Mlt.h>
 
        All definitions are placed in an Mlt namespace, and adhere closely to the C
        naming convention. Mappings always follow the pattern:
@@ -39,6 +48,12 @@ USAGE
        ie:     mlt_playlist_append             ==> Mlt::Playlist.append
                etc
 
+       Additionally, you can specify:
+
+               using namespace Mlt;
+
+       To avoid the enforced use of the Mlt:: prefix.
+
        Enumerators and macros are reused directly from the C library.
 
 CLASS HIERARCHY
@@ -72,24 +87,25 @@ SPECIAL CASES
 
        Note that you get an object back - it is never the original object, but a 
        wrapping object. This is done to keep consistency with the C api which may 
-       instantiate C instances - therefore there it cannot be assumed that a C++ 
-       object exists for all mlt service instances.
+       instantiate C instances - therefore it cannot be assumed that a C++ object 
+       exists for all mlt service instances.
 
        As such, it is mandatory that you delete these objects. The original will 
-       not be affected. Further to that, all modifications (to properties or its
+       not be affected. However, all other modifications (to properties or its
        state of connection) will be reflected in the original object.
 
-       This excludes the use of the RTTI to determine the real type of the object -
-       this can only be done by parsing the objects properties.
+       This approach excludes the use of RTTI to determine the real type of the 
+       object - this can only be done by parsing the objects properties.
 
-       Non-NULL objects may be invalid - always use the is_valid method to
-       check validity before use.
+       Objects may be invalid - always use the is_valid method to check validity 
+       before use.
 
 LIMITATIONS
 -----------
 
-       The mechanisms for the definition of new services have deliberately not 
-       been exposed by the C++ wrappings - this is done to ensure that service 
+       The mechanisms for the definition of new services are deliberately 
+       excluded from the C++ wrappings - this is done to ensure that service 
        networks constructed can be serialised and used by existing applications
        which are based on the C API (such as miracle).
 
+