openlayers/readme.md

OpenLayers 3

Build it

Run make:

$ make

Run the examples

Run make (as above), then explore the examples/ directory with your web browser.

Run the examples in debug mode

Run the Plovr web server with:

$ make serve

Then, start a simple webserver, for example:

$ python -mSimpleHTTPServer

Explore the examples/ directory through this server, for example http://localhost:8000/examples/side-by-side.html. You can turn off compilation by appending ?mode=RAW to the URL, for example http://localhost:8000/examples/side-by-side.html?mode=RAW.

Note that appending ?mode=RAW doesn't work with file:// URLs, which is why you need to access the examples/ directory though a web server.

Run tests

Run the plovr web server (see above), and either open the test/ol.html file in the browser (e.g. http://localhost:8000/test/ol.html), or run make test on the console (headless testing with PhantomJS).

See also the test-specific readme.

Run the linter

First, install the Closure Linter. Then:

$ make lint

Add examples

The examples are located in the examples directory. Adding a new example implies creating two files in this directory, a .html file and .js file. See examples/full-screen.html and examples/full-screen.js for instance.

The .html file needs to include a script tag with loader.js?id=<example_name> as its src. For example, if the two files for the examples are myexample.js and myexample.html then id should be set to myexample in the loader.js URL.

make serve should be stopped and restarted for the loader.js?id=<example_name> script tag to refer to a valid URL. make serve triggers the examples target which creates Plovr JSON file for each example.