README
changeset 1030 afd77187fd9a
parent 1029 9edcde420df2
child 1031 5746d89b5a40
equal deleted inserted replaced
1029:9edcde420df2 1030:afd77187fd9a
     1 This is the README for MetaDataPlayer, an opensource web player with metadata support.
       
     2 
       
     3 Features
       
     4 ========
       
     5 
       
     6     o Reads json-converted cinelab metadata
       
     7     o Reads from Youtube, Dailymotion and Flash backends
       
     8     o Loads the data as JSON as well as JSONP
       
     9     
       
    10 
       
    11 Requirements
       
    12 ============
       
    13 
       
    14 - jQuery 1.4
       
    15 - jQuery UI 1.4
       
    16 - the java jre (for building the sources)
       
    17 
       
    18 Building the library
       
    19 ====================
       
    20 
       
    21 The library files are scattered in many files. An ant build script has been made to make the developer and
       
    22 minified versions of the player. It is located in sbin/build/client.xml.
       
    23 To build the library, simply run sbin/build/compil.bat if you are running windows, or sbin/build/compil.sh
       
    24 if you're running Unix.
       
    25 
       
    26 Running the examples
       
    27 ====================
       
    28 
       
    29 You'll have to have a web server configured to serve the metadataplayer directory, because
       
    30 of the flash cross-domain policy.
       
    31 
       
    32 The code
       
    33 ========
       
    34 
       
    35 The code is scattered among several files, which are concatenated and minified during the
       
    36 build process. The html templates in the templates/ directory are also "jsified" during
       
    37 this process, to be used by the js code.