README
author hamidouk
Tue, 29 Nov 2011 11:09:08 +0100
branchpopcorn-port
changeset 345 8a088f7daa66
parent 52 2ec3deb0a0d5
permissions -rw-r--r--
rollover over the interface buttons now works as expected. Also changed the width of the buttons to the correct size. Resized the width and height of the sprites to be the same as the boxes we display them in.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
3496a9621bcf Added two basic README files
hamidouk
parents:
diff changeset
     1
This is the README for MetaDataPlayer, an opensource web player with metadata support.
3496a9621bcf Added two basic README files
hamidouk
parents:
diff changeset
     2
23
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
     3
Features
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
     4
========
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
     5
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
     6
    o Reads json-converted cinelab metadata
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
     7
    o Reads from Youtube, Dailymotion and Flash backends
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
     8
    o Loads the data as JSON as well as JSONP
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
     9
    
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
    10
10
3496a9621bcf Added two basic README files
hamidouk
parents:
diff changeset
    11
Requirements
3496a9621bcf Added two basic README files
hamidouk
parents:
diff changeset
    12
============
3496a9621bcf Added two basic README files
hamidouk
parents:
diff changeset
    13
3496a9621bcf Added two basic README files
hamidouk
parents:
diff changeset
    14
- jQuery 1.4
23
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
    15
- jQuery UI 1.4
52
2ec3deb0a0d5 Added a build script to build the js files on unix. Also changed README to
hamidouk
parents: 45
diff changeset
    16
- the java jre (for building the sources)
23
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
    17
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
    18
Building the library
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
    19
====================
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
    20
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
    21
The library files are scattered in many files. An ant build script has been made to make the developer and
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
    22
minified versions of the player. It is located in sbin/build/client.xml.
52
2ec3deb0a0d5 Added a build script to build the js files on unix. Also changed README to
hamidouk
parents: 45
diff changeset
    23
To build the library, simply run sbin/build/compil.bat if you are running windows, or sbin/build/compil.sh
2ec3deb0a0d5 Added a build script to build the js files on unix. Also changed README to
hamidouk
parents: 45
diff changeset
    24
if you're running Unix.
23
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
    25
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
    26
Running the examples
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
    27
====================
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
    28
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
    29
You'll have to have a web server configured to serve the metadataplayer directory, because
05286749d264 changed README.
hamidouk
parents: 10
diff changeset
    30
of the flash cross-domain policy.
45
355127a26162 changed README.
hamidouk
parents: 23
diff changeset
    31
355127a26162 changed README.
hamidouk
parents: 23
diff changeset
    32
The code
355127a26162 changed README.
hamidouk
parents: 23
diff changeset
    33
========
355127a26162 changed README.
hamidouk
parents: 23
diff changeset
    34
355127a26162 changed README.
hamidouk
parents: 23
diff changeset
    35
The code is scattered among several files, which are concatenated and minified during the
355127a26162 changed README.
hamidouk
parents: 23
diff changeset
    36
build process. The html templates in the templates/ directory are also "jsified" during
355127a26162 changed README.
hamidouk
parents: 23
diff changeset
    37
this process, to be used by the js code.