README.md
author durandn
Tue, 22 Sep 2015 17:07:58 +0200
changeset 1062 f8adaa2caecb
parent 1030 afd77187fd9a
child 1072 ac1eacb3aa33
permissions -rw-r--r--
CurrentSegmentInfobox: fixed bug where editing a segment would not update the source correctly and mess up other widgets.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1030
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
This is the README for MetaDataPlayer, an opensource web player with metadata support.
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
Features
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
========
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
    o Reads json-converted cinelab metadata
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
    o Reads from Youtube, Dailymotion and Flash backends
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
    o Loads the data as JSON as well as JSONP
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
    
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
Requirements
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
============
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    13
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    14
- jQuery 1.4
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    15
- jQuery UI 1.4
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
- the java jre (for building the sources)
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
Building the library
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
====================
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    20
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    21
The library files are scattered in many files. An ant build script has been made to make the developer and
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    22
minified versions of the player. It is located in sbin/build/client.xml.
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    23
To build the library, simply run sbin/build/compil.bat if you are running windows, or sbin/build/compil.sh
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    24
if you're running Unix.
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    25
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
Running the examples
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
====================
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    28
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    29
You'll have to have a web server configured to serve the metadataplayer directory, because
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    30
of the flash cross-domain policy.
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    31
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    32
The code
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    33
========
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    34
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    35
The code is scattered among several files, which are concatenated and minified during the
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    36
build process. The html templates in the templates/ directory are also "jsified" during
afd77187fd9a rename REAME + simplify hgignore
ymh <ymh.work@gmail.com>
parents:
diff changeset
    37
this process, to be used by the js code.