diff 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/resources/osc/node_modules/osc-min/lib/install.md	Tue May 17 16:01:06 2016 +0100
@@ -0,0 +1,31 @@
+~installation~
+ 
+The easiest way to get osc-min is through [NPM](http://npmjs.org).
+After install npm, you can install osc-min in the current directory with
+ 
+```
+npm install osc-min
+```
+ 
+If you'd rather get osc-min through github (for example, if you're forking
+it), you still need npm to install dependencies, which you can do with
+ 
+```
+npm install --dev
+```
+ 
+Once you've got all the dependencies you should be able to run the unit
+tests with 
+ 
+```
+npm test
+npm run-script coverage
+```
+
+### For the browser
+If you want to use this library in a browser, you can build a browserified file (`build/osc-min.js`) with
+
+```
+npm install --dev
+npm run-script browserify
+```
\ No newline at end of file