PageRenderTime 33ms CodeModel.GetById 22ms 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
    

  1. Route-Me: iOS map library
    2. 

  2. -------------------------
    3. 

  3. 

  4. Route-Me is an open source map library that runs natively on iOS.  It's designed
    5. 

  5. to look and feel much like the inbuilt iOS map library, but it's entirely open,
    6. 

  6. and works with any map source.
    7. 

  7. 

  8. Currently, [OpenStreetMap][1], [Microsoft VirtualEarth][2], [CloudMade][3],
    9. 

  9. [OpenAerialMap][4], [OpenCycleMap][5], [SpatialCloud][6], TileStream[7], and two
    10. 

  10. offline-capable, database-backed formats (DBMap and [MBTiles][8]) are supported
    11. 

  11. as map sources.
    12. 

  12. 

  13. Please note that you are responsible for getting permission to use the map data,
    14. 

  14. and for ensuring your use adheres to the relevant terms of use.
    15. 

  15. 

  16. 

  17.    [1]: http://www.openstreetmap.org/index.html
    18. 

  18.    [2]: http://maps.live.com/
    19. 

  19.    [3]: http://www.cloudmade.com/
    20. 

  20.    [4]: http://www.openaerialmap.org/
    21. 

  21.    [5]: http://www.opencyclemap.org/
    22. 

  22.    [6]: http://www.spatialcloud.com/
    23. 

  23.    [7]: http://mapbox.com/tilestream
    24. 

  24.    [8]: http://mbtiles.org/
    25. 

  25. 

  26. 

  27. Installing
    28. 

  28. ----------
    29. 

  29. 

  30. As Route-Me is undergoing some significant changes, the recommended course of
    31. 

  31. action is to clone a copy of the repository:
    32. 

  32. 

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

  34. 

  35. Or, [download the trunk][dl].
    36. 

  36. 

  37. See the 'samples' subdirectory for usage examples.
    38. 

  38. 

  39. 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.
    40. 

  40. 

  41. 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.
    42. 

  42. 

  43. 

  44.    [dl]: http://github.com/route-me/route-me/zipball/master
    45. 

  45.    
    46. 

  46.    
    47. 

  47. News, Support and Contributing
    48. 

  48. ------------------------------
    49. 

  49. 

  50. Join our [mailing list][list] for news and to communicate with project members
    51. 

  51. and other users:
    52. 

  52. 

  53. To report bugs and help fix them, please use the [issue tracker][tracker]
    54. 

  54. 

  55. [list]: http://groups.google.com/group/route-me-map
    56. 

  56. [tracker]: http://github.com/route-me/route-me/issues
    57. 

  57. 

  58.