Skip to content

Commit 792984d

Browse files
author
Dean Hudson
committed
Update docs, clean up gulpfile, new build
1 parent 34d66b5 commit 792984d

File tree

5 files changed

+24
-41450
lines changed

5 files changed

+24
-41450
lines changed

README.md

+10-22
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ simple JavaScript interface.
66
## Installation
77

88
Download the minified JS
9-
[here](https://raw.github.com/openaura/js-sdk/deanh/artist-search/oa-all.min.js) and include
9+
[here](https://raw.github.com/openaura/js-sdk/build/js/oa-all.js) and include
1010
it in your HTML via a script tag.
1111

1212
## Usage
@@ -121,28 +121,16 @@ pixels, and at most 1000x3000 pixels:
121121

122122
## Building
123123

124-
This project has the following setup:
124+
This project uses [Gulp](http://gulpjs.com/) to build. Assuming you
125+
have Node.js and npm installed, cd into the project directory and:
125126

126-
* www/ - the web assets for the project
127-
* app.js - the top-level config script used by index.html
128-
* app/ - the directory to store project-specific scripts.
129-
* lib/ - the directory to hold third party scripts.
130-
* tools/ - the build tools to optimize the project.
127+
```
128+
$ npm install -f gulp
131129
132-
To build, run:
130+
$ npm install
131+
```
133132

134-
node tools/r.js -o tools/build.js && cp www-built/app/all.js oa-all.min.js
133+
To build, run ```gulp package```. You should end up with a single file
134+
in build/js/oa-all.js. You can open (and play around with)
135+
build/index.html, which includes the JS in a script tag.
135136

136-
That build command creates minified version of the project in a
137-
**www-built** directory. The app/all.js file will be optimized to
138-
include all of its dependencies, and is copied to the main dir for
139-
distribution.
140-
141-
The example-all.html file in the main directory loads the minified
142-
file, so you can expeiment with it in your browser console.
143-
144-
For more information on the optimizer:
145-
http://requirejs.org/docs/optimization.html
146-
147-
For more information on using requirejs:
148-
http://requirejs.org/docs/api.html

build/index.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<!DOCTYPE html>
22
<html>
33
<head>
4-
<title>Iso Tile Test Page</title>
4+
<title>OpenAura JSDSK Test Page</title>
55
</head>
66
<body>
7-
<script src="js/all.js"></script>
7+
<script src="js/oa-all.js"></script>
88
</body>
99
</html>

0 commit comments

Comments
 (0)