README.md
changeset 1072 ac1eacb3aa33
parent 1030 afd77187fd9a
equal deleted inserted replaced
1071:02c04d2c8fd8 1072:ac1eacb3aa33
     5 
     5 
     6     o Reads json-converted cinelab metadata
     6     o Reads json-converted cinelab metadata
     7     o Reads from Youtube, Dailymotion and Flash backends
     7     o Reads from Youtube, Dailymotion and Flash backends
     8     o Loads the data as JSON as well as JSONP
     8     o Loads the data as JSON as well as JSONP
     9     
     9     
    10 
    10 Prerequisite
    11 Requirements
       
    12 ============
    11 ============
    13 
    12 
    14 - jQuery 1.4
    13 - node + npm
    15 - jQuery UI 1.4
    14 - `$ npm install`
    16 - the java jre (for building the sources)
       
    17 
    15 
    18 Building the library
    16 Building the library
    19 ====================
    17 ====================
    20 
    18 
    21 The library files are scattered in many files. An ant build script has been made to make the developer and
    19 The library files are scattered in many files. 
    22 minified versions of the player. It is located in sbin/build/client.xml.
    20 It is built with vite.
    23 To build the library, simply run sbin/build/compil.bat if you are running windows, or sbin/build/compil.sh
    21 - `$ npm run build`
    24 if you're running Unix.
    22 
       
    23 The result of the build is in the dist/ folder.
    25 
    24 
    26 Running the examples
    25 Running the examples
    27 ====================
    26 ====================
    28 
    27 
    29 You'll have to have a web server configured to serve the metadataplayer directory, because
    28 - `npm dev`
    30 of the flash cross-domain policy.
    29 
       
    30 or for building the dist:
       
    31 - `vite build -w` + `python -m http.server 5173`
       
    32 
    31 
    33 
    32 The code
    34 The code
    33 ========
    35 ========
    34 
    36 
    35 The code is scattered among several files, which are concatenated and minified during the
    37 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
    38 build process. The html templates in the templates/ directory are also "jsified" during
    37 this process, to be used by the js code.
    39 this process, to be used by the js code.
       
    40 
       
    41 **TODO:** finish the migration of the examples and widgets. Replace the JwPlayer widget with an open source js video player that can play youtube and wimeo videos. Adapt  the AdaptivePlayer accordingly.