Mercurial > hg > beaglert
annotate resources/osc/node_modules/osc-min/lib/install.md @ 271:fb9c28a4676b prerelease
Added osc example project and node script for testing
author | Liam Donovan <l.b.donovan@qmul.ac.uk> |
---|---|
date | Tue, 17 May 2016 16:01:06 +0100 |
parents | |
children |
rev | line source |
---|---|
l@271 | 1 ~installation~ |
l@271 | 2 |
l@271 | 3 The easiest way to get osc-min is through [NPM](http://npmjs.org). |
l@271 | 4 After install npm, you can install osc-min in the current directory with |
l@271 | 5 |
l@271 | 6 ``` |
l@271 | 7 npm install osc-min |
l@271 | 8 ``` |
l@271 | 9 |
l@271 | 10 If you'd rather get osc-min through github (for example, if you're forking |
l@271 | 11 it), you still need npm to install dependencies, which you can do with |
l@271 | 12 |
l@271 | 13 ``` |
l@271 | 14 npm install --dev |
l@271 | 15 ``` |
l@271 | 16 |
l@271 | 17 Once you've got all the dependencies you should be able to run the unit |
l@271 | 18 tests with |
l@271 | 19 |
l@271 | 20 ``` |
l@271 | 21 npm test |
l@271 | 22 npm run-script coverage |
l@271 | 23 ``` |
l@271 | 24 |
l@271 | 25 ### For the browser |
l@271 | 26 If you want to use this library in a browser, you can build a browserified file (`build/osc-min.js`) with |
l@271 | 27 |
l@271 | 28 ``` |
l@271 | 29 npm install --dev |
l@271 | 30 npm run-script browserify |
l@271 | 31 ``` |