Skip to content

Commit 46fc905

Browse files
author
Lanny McNie
committed
Updated build README
Signed-off-by: Lanny McNie <[email protected]>
1 parent 218401f commit 46fc905

File tree

1 file changed

+19
-23
lines changed

1 file changed

+19
-23
lines changed

build/README.md

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,33 @@
22

33
## To use
44

5+
Note that this requires a familiarity with using the command line. The example commands shown are for use with the OSX Terminal.
6+
57
### Install dependencies
68

7-
Node (0.10.x or greater is required):
9+
Node (0.10.2 or greater is required):
810

9-
# check the version
11+
# check the version via the command line
1012
node -v
1113

12-
If your node is out of date, install the latest from [NodeJS.org](http://nodejs.org/)
14+
If your Node install is out of date, get the latest from [NodeJS.org](http://nodejs.org/)
1315

14-
After node is setup, install the other dependencies:
16+
After node is setup, install the other dependencies. You may want to familiarize yourself with the Node Packager Manager (NPM) before proceeding.
1517

16-
# Install the grunt command line utility
18+
# Install the grunt command line utility globally
1719
sudo npm install grunt-cli -g
1820

19-
# Install all the dependencies for this project.
21+
# Change to the build directory, which contains package.json
22+
cd /path/to/libraryName/build/
23+
24+
# Install all the dependencies from package.json
2025
npm install
2126

2227
# Setup
2328

24-
You'll need to change the default settings to suit your work environment.
25-
We have 2 config files:
26-
27-
* config.json - Is meant to be in git and pushed to all developers.
28-
* config.local.json - Is added to .gitignore and and only for your local setup (any settings in here will override those in config.json)
29-
30-
Please adjust these settings to match your environment. All paths can either be relative from the build folder, or absolute paths.
29+
You can change the default settings to suit your local work environment by overriding them in a "config.local.json" file in the build directory. All paths can either be relative to the build folder, or absolute paths.
3130

32-
* docs_out_path - Location of the created YUIdocs. (Will be in your CreateJS.com/Docs/ folder)
31+
* docs_out_path - Location of the uncompressed generated docs.
3332

3433
### Building
3534
To export a release build for this library run:
@@ -38,17 +37,14 @@ To export a release build for this library run:
3837

3938
This command will:
4039

41-
* Update the version.js file(s).
42-
* Create the {PROJECT_NAME}-{VERSION}.min.js file
43-
* Compile the docs to config.docs_out_path
44-
* Create a zip file of the docs/
45-
* Copy the docs zip to ../docs
46-
* Copy the built js file to ../lib
47-
* Copy All examples from ../examples to config.examples_out_path
40+
* Update the version.js file(s) with the current date and version number from config
41+
* Create the {PROJECT_NAME}-{VERSION}.min.js file, and move it to ../lib
42+
* Generate the documentation in the docs_out_path from config
43+
* Create a zip file of the documentation and move it to ../docs
4844

4945
**NEXT version**
5046

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.
47+
The same process as above, but uses "NEXT" as the version. This is used to generate minified builds with the latest source between release versions.
5248

5349
grunt next
5450

@@ -65,4 +61,4 @@ The same as the NEXT process, but will not minify the source code. All code form
6561
* grunt next - Build everything using the NEXT version.
6662
* grunt combine - Build a NEXT version, but leave comments and formatting intact.
6763
* grunt docs - Build only the docs
68-
* grunt uglify - Create the SoundJS and FlashPlugin min files. (Will use NEXT as the version)
64+
* grunt uglify - Create the PreloadJS min file. (Will use NEXT as the version)

0 commit comments

Comments
 (0)