1- ## We use grunt (http://gruntjs.com/ ) to manage our build process.
2-
3- If you previously used an older process, you may want to clean up the node_modules and output folders.
1+ ## SoundJS uses [ Grunt] ( http://gruntjs.com/ ) to manage the build process.
42
53## To use
64
75### Install dependencies
86
97Node (0.10.x or greater is required):
108
11- # check the version
12- node -v
9+ # check the version
10+ node -v
1311
14- If your node is out of date, install the latest from:
15- http://nodejs.org/
12+ If your node is out of date, install the latest from [ NodeJS.org] ( http://nodejs.org/ )
1613
1714After node is setup, install the other dependencies:
1815
19- # Install the grunt command line utility
20- sudo npm install grunt-cli -g
16+ # Install the grunt command line utility
17+ sudo npm install grunt-cli -g
2118
22- # Install all the dependencies for this project.
23- npm install
19+ # Install all the dependencies for this project.
20+ npm install
2421
25- ### Setup
22+ # Setup
2623
2724You'll need to change the default settings to suit your work environment.
2825We have 2 config files:
@@ -37,7 +34,7 @@ Please adjust these settings to match your environment. All paths can either be
3734### Building
3835To export a release build for this library run:
3936
40- grunt build
37+ grunt build
4138
4239This command will:
4340
@@ -49,16 +46,23 @@ This command will:
4946* Copy the built js file to ../lib
5047* Copy All examples from ../examples to config.examples_out_path
5148
52- To build the NEXT version run:
49+ ** NEXT version**
50+
51+ The same process as above, but uses "NEXT" as the version. This is used to generate minified builds with the latest source between tags.
52+
53+ grunt next
54+
55+ ** Combined File**
5356
54- grunt next
57+ The same as the NEXT process, but will not minify the source code. All code formatting and comments are left intact.
5558
56- Does the exact same process as above but uses NEXT as the version.
59+ grunt combine
5760
5861
5962### All commands
6063
61- grunt build - Build everything based on the version in package.json
62- grunt next - Build everything using the NEXT version.
63- grunt docs - Build only the docs
64- grunt uglify - Create the Easel and MovieClip min files. (Will use NEXT as the version)
64+ * grunt build - Build everything based on the version in package.json
65+ * grunt next - Build everything using the NEXT version.
66+ * grunt combine - Build a NEXT version, but leave comments and formatting intact.
67+ * grunt docs - Build only the docs
68+ * grunt uglify - Create the SoundJS and FlashPlugin min files. (Will use NEXT as the version)
0 commit comments