Update readme.md

This commit is contained in:
Éric Lemoine
2013-03-06 20:45:08 +01:00
parent 757401313b
commit 306447fac7
+17 -10
View File
@@ -7,10 +7,15 @@
The examples are hosted on GitHub (as GitHub pages): http://openlayers.github.com/ol3/master/examples/. The examples are hosted on GitHub (as GitHub pages): http://openlayers.github.com/ol3/master/examples/.
By default the examples use the `ol.js` script, which is compiled using Closure Compiler's ADVANVCED mode. By default the examples use the `ol.js` script, which is compiled using Closure
By appending `?mode=simple` or `?mode=whitespace` to the URL you can make the example page load `ol-simple.js` Compiler's ADVANCED mode. By appending `?mode=simple` or `?mode=whitespace` to
or `ol-whitespace.js` instead of `ol.js`. As their names suggest it, `ol-simple.js` and `ol-whitespace.js` the URL you can make the example page load the `ol-simple.js` or
are compiled using the SIMPLE and WHITESPACE modes, respectively. For example: `ol-whitespace.js` builds instead of `ol.js`. As their names suggest it,
`ol-simple.js` and `ol-whitespace.js` are compiled using the SIMPLE and
WHITESPACE modes, respectively. And by appending `?mode=debug` or `?mode=raw`
you will make the example work in full debug mode.
For example:
http://openlayers.github.com/ol3/master/examples/full-screen.html?mode=simple. http://openlayers.github.com/ol3/master/examples/full-screen.html?mode=simple.
## Build OpenLayers 3 ## Build OpenLayers 3
@@ -47,12 +52,14 @@ on GitHub. Start by executing the `hostexamples` build target:
$ ./build.py hostexamples $ ./build.py hostexamples
This will build `ol.js`, `ol-simple.js`, `ol-whitespace.js`, and `ol.css`, create the examples index page, This will build `ol.js`, `ol-simple.js`, `ol-whitespace.js`, and `ol.css`,
and copy everything to `build/gh-pages/<branch_name>/`, where `<branch_name>` is the name of the local create the examples index page, and copy everything to
checked out Git branch. You can now open the examples index page in the browser, for example: `build/gh-pages/<branch_name>/`, where `<branch_name>` is the name of the local
<http://localhost:8000/build/gh-pages/master/examples/>. To make an example use `ol-simple.js` or checked out Git branch. You can now open the examples index page in the
`ol-whitespace.js` instead of `ol.js` append `?mode=simple` or `?mode=whitespace` to the example browser, for example: <http://localhost:8000/build/gh-pages/master/examples/>.
URL. To make an example use `ol-simple.js` or `ol-whitespace.js` instead of `ol.js`
append `?mode=simple` or `?mode=whitespace` to the example URL. And append
`?mode=debug` or `?mode=raw` to make the example work in full debug mode.
## Run tests ## Run tests