comparison resources/osc/node_modules/osc-min/lib/install.md @ 284:7bfb25a2e158 Doxy prerelease

Merge
author Robert Jack <robert.h.jack@gmail.com>
date Tue, 17 May 2016 15:53:24 +0100
parents fb9c28a4676b
children
comparison
equal deleted inserted replaced
269:ac8eb07afcf5 284:7bfb25a2e158
1 ~installation~
2
3 The easiest way to get osc-min is through [NPM](http://npmjs.org).
4 After install npm, you can install osc-min in the current directory with
5
6 ```
7 npm install osc-min
8 ```
9
10 If you'd rather get osc-min through github (for example, if you're forking
11 it), you still need npm to install dependencies, which you can do with
12
13 ```
14 npm install --dev
15 ```
16
17 Once you've got all the dependencies you should be able to run the unit
18 tests with
19
20 ```
21 npm test
22 npm run-script coverage
23 ```
24
25 ### For the browser
26 If you want to use this library in a browser, you can build a browserified file (`build/osc-min.js`) with
27
28 ```
29 npm install --dev
30 npm run-script browserify
31 ```