Files
openlayers/readme.md
2012-09-28 14:02:57 +02:00

48 lines
1.3 KiB
Markdown

# OpenLayers 3
[![Travis CI Status](https://secure.travis-ci.org/openlayers/ol3.png)](http://travis-ci.org/#!/openlayers/ol3)
## 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](http://plovr.com/) 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](https://github.com/openlayers/ol3/tree/master/test).
## Run the linter
First, install the [Closure
Linter](https://developers.google.com/closure/utilities/docs/linter_howto).
Then:
$ make lint