Permalink
Browse files

Added new GitHub-compatible README

  • Loading branch information...
1 parent dbe3352 commit 6768e687c62893878e1c2237ab30bb18ca7d1312 @michaeltyson michaeltyson committed Oct 24, 2010
Showing with 50 additions and 23 deletions.
  1. +50 −0 README.markdown
  2. +0 −23 ReadmeRouteMe.txt
View
@@ -0,0 +1,50 @@
+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][1], [Microsoft VirtualEarth][2] and [CloudMade][3] 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.
+
+
+ [1]: http://www.openstreetmap.org/index.html
+ [2]: http://maps.live.com/
+ [3]: http://www.cloudmade.com/
+
+
+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][dl].
+
+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.
+
+
+ [dl]: http://github.com/route-me/route-me/zipball/master
+
+
+News, Support and Contributing
+------------------------------
+
+Join our [mailing list][list] for news and to communicate with project members
+and other users:
+
+To report bugs and help fix them, please use the [issue tracker][tracker]
+
+[list]: http://groups.google.com/group/route-me-map
+[tracker]: http://github.com/route-me/route-me/issues
+
View
@@ -1,23 +0,0 @@
-Route-Me: A native slippy map for the iPhone.
-
-Project home page is here:
-http://code.google.com/p/route-me/
-
-Best practice is to use Subversion to checkout the repository:
-svn checkout http://route-me.googlecode.com/svn/trunk/ route-me-read-only
-If you prefer, you can download a tarball from
-http://code.google.com/p/route-me/downloads/list
-
-A live copy of Doxygen-generated documentation is at
-http://www.mobilegeographics.com/dev/routeme/
-
-For news and updates and help, join our mailing list:
-http://groups.google.com/group/route-me-map
-
-To report bugs and help fix them, see the Issue Tracker:
-http://code.google.com/p/route-me/issues/list
-
-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.
-

0 comments on commit 6768e68

Please sign in to comment.