annotate README.md @ 2721:2bc86ec0ac6c

Merge branch 'master' of https://github.com/BrechtDeMan/WebAudioEvaluationTool
author www-data <www-data@sucuk.dcs.qmul.ac.uk>
date Fri, 14 Apr 2017 17:21:11 +0100
parents c95306462085
children 142df41a1aeb
rev   line source
b@2197 1 # Web Audio Evaluation Tool
b@2197 2
b@2197 3 ## Authors
b@2197 4
b@2197 5 | Author | e-mail |
b@2197 6 | ------- | ------ |
b@2370 7 | Nicholas Jillings | <[nicholas.jillings@mail.bcu.ac.uk](mailto:nicholas.jillings@mail.bcu.ac.uk)> |
b@2370 8 | Brecht De Man | <[b.deman@qmul.ac.uk](mailto:b.deman@qmul.ac.uk)> |
b@2370 9 | David Moffat | <[d.j.moffat@qmul.ac.uk](mailto:d.j.moffat@qmul.ac.uk)>|
b@2370 10 | Joshua D. Reiss (supervisor) | <[joshua.reiss@qmul.ac.uk](mailto:joshua.reiss@qmul.ac.uk)> |
b@2370 11 | Ryan Stables (supervisor) | <[ryan.stables@bcu.ac.uk](mailto:ryan.stables@bcu.ac.uk)> |
b@2197 12
b@2197 13
b@2197 14 ## Instructions
b@2197 15
b@2451 16 Please refer to the [Wiki](https://github.com/BrechtDeMan/WebAudioEvaluationTool/wiki).
b@2197 17
b@2439 18 ### Preview
b@2439 19 The video below shows you can set up a simple test from scratch in under five minutes (click to open):
b@2439 20 [![Web Audio Evaluation Tool test setup](https://img.youtube.com/vi/T_rwE6Gt9sI/0.jpg)](https://www.youtube.com/watch?v=T_rwE6Gt9sI)
b@2197 21
b@2473 22 ## Dependencies and compatibility
b@2273 23
b@2273 24 Runs out of the box on any web server with PHP (tested on PHP 5.1<=), no third party software needed.
b@2273 25
b@2273 26 Alternatively, a local server (no web server or internet connection needed!) and optional Python analysis scripts run on Python 2.7 or 3.x.
b@2273 27 Plots rendered using [matplotlib](http://matplotlib.org), [NumPy](http://matplotlib.org) and [SciPy](http://scipy.org).
b@2273 28
b@2473 29 As Microsoft Internet Explorer [does not support the Web Audio API](http://caniuse.com/#feat=audio-api), you will need another browser like Firefox, Chrome, Edge or Safari.
b@2273 30
b@2544 31 ## Citing
b@2197 32
b@2544 33 When using the Web Audio Evaluation Tool, please acknowledge the authors and cite
b@2198 34
b@2198 35 > Nicholas Jillings, Brecht De Man, David Moffat and Joshua D. Reiss, "[Web Audio Evaluation Tool: A Browser-Based Listening Test Environment](http://www.brechtdeman.com/publications/smc10.pdf)," [12th Sound and Music Computing Conference](http://www.maynoothuniversity.ie/smc15/), July 2015.
b@2198 36
b@2198 37 BibTeX:
b@2198 38
b@2198 39 @conference{waet2015,
b@2198 40 Author = {Jillings, Nicholas and Moffat, David and De Man, Brecht and Reiss, Joshua D.},
b@2198 41 Booktitle = {12th Sound and Music Computing Conference},
b@2198 42 Month = {July},
b@2198 43 Title = {Web {A}udio {E}valuation {T}ool: {A} browser-based listening test environment},
b@2198 44 Year = {2015}}
b@2197 45
b@2544 46 ## License
b@2207 47
b@2207 48 Please refer to LICENSE.txt ([GNU General Public License](http://www.gnu.org/licenses/gpl-3.0.en.html)).
b@2197 49
b@2544 50 If you wish to use elements of the Web Audio Evaluation Tool as part of a commercial product, please contact us for a commercial license.