www.aleph1.co.uk Git - yaffs-website/blob - node_modules/videojs-swf/README.md

   1 The light-weight Flash video player that makes Flash work like HTML5 video. This allows player skins, plugins, and other features to work with both HTML5 and Flash
   2
   3 This project doesn't need to be used if you simply want to use the Flash video player.  Head back to the main Video.js project if that's all you need, as the compiled SWF is checked in there.
   4
   5 ## Installation
   6
   7 1. Install Node Packages.
   8 ```bash
   9     npm install
  10    ```
  11 2. Compile SWF.
  12 Development (places new SWF in /dist/):
  13 ```bash
  14     grunt mxmlc
  15    ```
  16 Production/ Distribution (runs mxmlc task and copies SWF to dist/):
  17 ```bash
  18     grunt dist
  19    ```
  20 3. Run Connect Server.
  21 ```bash
  22     grunt connect:dev
  23 ```
  24 4. Open your browser at [http://localhost:8000/index.html](http://localhost:8000/index.html) to see a video play.  You can keep using grunt to rebuild the Flash code.
  25
  26 ## Releasing
  27
  28 1. Make sure that the following file is modified with these values:
  29
  30 ```
  31 node_modules/flex-sdk/lib/flex_sdk/frameworks/flex-config.xml
  32 ```
  33
  34 ```xml
  35 <!-- Specifies the minimum player version that will run the compiled SWF. -->
  36 <target-player>10.3</target-player>
  37
  38 <!-- Specifies the version of the compiled SWF -->
  39 <swf-version>12</swf-version>
  40 ```
  41
  42 2. Run the commands:
  43 ```sh
  44 npm version {major,minor,patch}
  45 npm publish
  46 ```
  47 The swf and changelog will be automatically built and added to the repo on version.
  48
  49 ## Running Unit and Integration Tests
  50
  51 ** Note - We want to drop all of this for grunt based / Karma testing.
  52
  53 For unit tests, this project uses [FlexUnit](http://flexunit.org/). The unit tests can be found in [project root]/src/com/videojs/test/
  54
  55 For integration tests, this project uses [qunit](http://qunitjs.com/). The integration tests can be found in [project root]/test
  56
  57 In order to run all of the tests, use the links at  [http://localhost:8000/index.html](http://localhost:8000/index.html)
  58
  59 There are very few tests.  Adding to them is a fantastic and much appreciated way to contribute.