From 2238c9bd6aaf2666a9fa22a429673a582308446e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Mon, 4 Mar 2013 10:15:31 +0100 Subject: [PATCH] Update readme.md --- readme.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/readme.md b/readme.md index e969219100..b94f437aa9 100644 --- a/readme.md +++ b/readme.md @@ -21,7 +21,7 @@ Run build.py: Windows users should run `build` instead. -## Run examples locally +## Run Examples locally Run the [Plovr](http://plovr.com/) web server with: @@ -39,18 +39,20 @@ and explore the `examples/` directory, for example by opening You can turn off compilation by appending `?mode=RAW` to the URL, for example . (By default mode is `ADVANCED`.) +Run examples without Plovr: + The examples can also be run against the `ol.js` standalone lib, without Plovr, just like the examples [hosted](http://openlayers.github.com/ol3/master/examples/) -on GitHub. You will want to run the examples against the standalone lib to verify -that will work correctly when copied on GitHub (as GitHub pages). Start by executing -the `hostexamples` build target: +on GitHub. Start by executing the `hostexamples` build target: $ ./build.py hostexamples -This will build `ol.js` and `ol.css`, creates the examples index page, and copy everything to -`build/gh-pages//`, where `` is the name of the local checked -out Git branch. You can now open the `build/gh-pages/examples` directory -in the browser, for example: . +This will build `ol.js`, `ol-simple.js`, `ol-whitespace.js`, and `ol.css`, create the examples index page, +and copy everything to `build/gh-pages//`, where `` is the name of the local +checked out Git branch. You can now open the examples index page in the browser, for example: +. 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. ## Run tests