README.markdown



Route-Me: iOS map library

Route-Me is an open source map library that runs natively on iOS.  It's designed
to look and feel much like the inbuilt iOS map library, but it's entirely open,
and works with any map source.

Currently, OpenStreetMap, Microsoft VirtualEarth, CloudMade,
OpenAerialMap, OpenCycleMap, SpatialCloud, and two offline,
database-backed formats (DBMap and MBTiles) are supported as map
sources.

Please note that you are responsible for getting permission to use the map data,
and for ensuring your use adheres to the relevant terms of use.


Installing

As Route-Me is undergoing some significant changes, the recommended course of
action is to clone a copy of the repository:

  git://github.com/route-me/route-me.git


Or, download the trunk.

See the 'samples' subdirectory for usage examples.

There are three subdirectories - MapView, Proj4, and samples. Proj4 is a support class used to do map projections. The MapView project contains only the route-me map library. "samples" contains some ready-to-build projects which you may use as starting points for your own applications, and also some engineering test cases. samples/SampleMap and samples/ProgrammaticMap are the best places to look, to see how to embed a Route-Me map in your application.

See LicenseRouteMe.txt for license details. In any app that uses the Route-Me library, include the following text on your "preferences" or "about" screen: "Uses Route-Me map library, (c) 2008-2010 Route-Me Contributors". Your data provider will have additional attribution requirements.


News, Support and Contributing

Join our mailing list for news and to communicate with project members
and other users:

To report bugs and help fix them, please use the issue tracker


Changes in this fork (Alpstein/route-me)


RMMapView and RMMapContents have been merged into one file
The map uses an UIScrollView with a CATiledLayer for better performance
Tile cache refactoring
Tile source refactoring
Support for tile sources with multiple layers
Numerous performance improvements
Markers have been refactored into a MKMapView-like system, with annotations and on-demand markers
Automatic annotation clustering
Requires at least iOS 4.0