PageRenderTime 23ms CodeModel.GetById 12ms app.highlight 8ms RepoModel.GetById 1ms app.codeStats 0ms

/README.markdown

http://github.com/route-me/route-me
Markdown | 57 lines | 36 code | 21 blank | 0 comment | 0 complexity | 86f4826f6e08f0a2910ddc71cc0071f9 MD5 | raw file
 1Route-Me: iOS map library
 2-------------------------
 3
 4Route-Me is an open source map library that runs natively on iOS.  It's designed
 5to look and feel much like the inbuilt iOS map library, but it's entirely open,
 6and works with any map source.
 7
 8Currently, [OpenStreetMap][1], [Microsoft VirtualEarth][2], [CloudMade][3],
 9[OpenAerialMap][4], [OpenCycleMap][5], [SpatialCloud][6], TileStream[7], and two
10offline-capable, database-backed formats (DBMap and [MBTiles][8]) are supported
11as map sources.
12
13Please note that you are responsible for getting permission to use the map data,
14and for ensuring your use adheres to the relevant terms of use.
15
16
17   [1]: http://www.openstreetmap.org/index.html
18   [2]: http://maps.live.com/
19   [3]: http://www.cloudmade.com/
20   [4]: http://www.openaerialmap.org/
21   [5]: http://www.opencyclemap.org/
22   [6]: http://www.spatialcloud.com/
23   [7]: http://mapbox.com/tilestream
24   [8]: http://mbtiles.org/
25
26
27Installing
28----------
29
30As Route-Me is undergoing some significant changes, the recommended course of
31action is to clone a copy of the repository:
32
33      git://github.com/route-me/route-me.git
34
35Or, [download the trunk][dl].
36
37See the 'samples' subdirectory for usage examples.
38
39There 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.
40
41See 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.
42
43
44   [dl]: http://github.com/route-me/route-me/zipball/master
45   
46   
47News, Support and Contributing
48------------------------------
49
50Join our [mailing list][list] for news and to communicate with project members
51and other users:
52
53To report bugs and help fix them, please use the [issue tracker][tracker]
54
55[list]: http://groups.google.com/group/route-me-map
56[tracker]: http://github.com/route-me/route-me/issues
57