#We recommend that developers now use: http://github.com/universalviewer
Navigate sequences of images in a zoomable, extensible interface.
See the GitHub releases page.
Please see the wiki for instructions on how to customise the player for your own projects.
First Time Setup
All command-line operations for building the Wellcome Player are scripted using Grunt which is based on Node.js. We are using Node for this project because it provides a powerful cross-platform collection of tools with minimal setup overhead. To get set up:
- Install Node.js, if you haven't already
- Install the Grunt command line interface (if you haven't already); on the command line, run
npm install -g grunt-cli
- Clone the 'player' repository
- On the command line, go in to the 'player' folder
git submodule init
git submodule update
To build the debug version of the player, just run (on the command line, in the 'player' folder):
To build the release version of the player, just run (on the command line, in the 'player' folder):
The built files appear in the 'build' folder.
If you want to build tar and zip files for distribution (they will also appear in the 'build' folder), use:
Note that the 'build' folder is masked with .gitignore; it's just for your local use, and won't be checked in to the repository.
To view the examples run:
The Wellcome Player is released under the MIT license. For details, see the file LICENSE.txt.