Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
JavaScript Python Other

This branch is 1875 commits behind openlayers:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
apidoc_config
art
build
doc
doc_config
examples
img
lib
notes
tests
theme/default
tools
.gitignore
license.txt
readme.md
release-license.txt
repository-license.txt

readme.md

OpenLayers

Copyright (c) 2005-2012 OpenLayers Contributors. See authors.txt for more details.

OpenLayers is a JavaScript library for building map applications on the web. OpenLayers is made available under a BSD-license. Please see license.txt in this distribution for more details.

Getting OpenLayers

OpenLayers lives at http://www.openlayers.org/. Find details on downloading stable releases or the development version the development site

Installing OpenLayers

You can use OpenLayers as-is by copying build/OpenLayers.js and the entire theme/ and img/ directories up to your webserver and putting them in the same directory. The files can be in subdirectories on your website, or right in the root of the site, as in these examples. To include the OpenLayers library in your web page from the root of the site, use:

<script type="text/javascript" src="/OpenLayers.js" />

As an example, using bash (with the release files in ~/openlayers):

$ cd /var/www/html
$ cp ~/openlayers/OpenLayers.js ./
$ cp -R ~/openlayers/theme ./
$ cp -R ~/openlayers/img ./

If you want to use the multiple-file version of OpenLayers (for, say, debugging or development purposes), copy the lib/ directory up to your webserver in the same directory you put the img/ folder. Then add the following to your web page instead:

<script type="text/javascript" src="/lib/OpenLayers.js" />

As an example, using bash (with the release files in ~/openlayers):

$ cd /var/www/html
$ cp -R ~/openlayers/lib ./
$ cp -R ~/openlayers/theme ./
$ cp -R ~/openlayers/img ./

Using OpenLayers in Your Own Website

The examples directory is full of useful examples.

Documentation is available at http://trac.osgeo.org/openlayers/wiki/Documentation. You can generate the API documentation with http://www.naturaldocs.org/: As an example, using bash (with the release files in ~/openlayers):

$ cd ~/openlayers/
$ /path/to/NaturalDocs -i lib/ -o HTML doc/ -p doc_config/ -s Default OL

Information on changes in the API is available in release notes found in the notes folder.

Contributing to OpenLayers

Please join the email lists at http://openlayers.org/mailman/listinfo Patches are welcome!

Something went wrong with that request. Please try again.