OpenLayers 3
Pull request Compare This branch is 11816 commits behind openlayers:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin
build
css
doc
examples
externs
licenses
src
test
.gitignore
.travis.yml
CONTRIBUTING.md
authors.txt
base.json
build.py
license.txt
pake.py
readme.md

readme.md

OpenLayers 3

Travis CI Status

Build it

Run make:

$ ./build.py

Run the examples in debug mode

Run the Plovr web server with:

$ ./build.py serve

Then, either open one of the example html files from the examples directory directly in your browser, or start a simple webserver, for example:

$ python -mSimpleHTTPServer

and explore the examples/ directory, for example by opening 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.

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 ./build.py test on the console (headless testing with PhantomJS).

See also the test-specific readme.

Run the linter

First, install the Closure Linter. Then:

$ ./build.py 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.