Previously we had both a `clean` and `reallyclean` in our Makefile; both got lost when we switched to a python build. A clean 'target' can be invoked by calling the build script with the '-c' flag: ./build.py -c This commit readds the `reallyclean` target and lets it clean up a little more than the Makefiles `clean` or `reallyclean` did. More files are deleted, but only if these are being ignored inside of the repository (e.g. through .gitignore files).
OpenLayers 3
Hosted Examples
The examples are hosted on GitHub (as GitHub pages). See http://openlayers.github.com/ol3/master/examples/.
Build OpenLayers 3
Run build.py:
$ ./build.py
Run examples locally
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, make sure to install it first from http://phantomjs.org/download.html).
See also the test-specific readme.
Run the linter
First, install the Closure Linter. Then:
$ ./build.py lint
Run the precommit hook before pushing a commit:
$ ./build.py precommit
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.
build.py serve should be stopped and restarted for the
loader.js?id=<example_name> script tag to refer to a valid URL. build.py serve
triggers the examples target which creates Plovr JSON file for each example.
