From da825c27dad01efc169dbbf9e75c5dd3e84d3944 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Wed, 20 Feb 2013 14:22:13 +0100 Subject: [PATCH] Update Run examples locally readme section --- readme.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 7e549ce4c5..912b5b9afb 100644 --- a/readme.md +++ b/readme.md @@ -21,7 +21,7 @@ Run the [Plovr](http://plovr.com/) web server with: $ ./build.py serve -Windows users should run `build serve` instead. +Windows users should run `build.py serve` instead. Then, either open one of the example html files from the `examples` directory directly in your browser, or start a simple webserver, for example: @@ -31,7 +31,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`.) + +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: + + $ ./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: . ## Run tests