masoud2v / osmdroid Goto Github PK

#osmdroid

osmdroid is a (almost) full/free replacement for Android's MapView (v1 API) class. It also includes a modular tile provider system with support for numerous online and offline tile sources and overlay support with built-in overlays for plotting icons, tracking location, and drawing shapes.

osmdroid is migrated from Google Code. See issue 1.

##Prerequisites

Before you add osmdroid to your project make sure you check the Prerequisites page.

##I want to use osmdroid in my project

You can include osmdroid using Maven or by adding a jar file to your project. See HowToIncludeInYourProject.

You may find it useful to read the Javadoc.

##I want to compile the source

The preferred method is by using Maven. See HowToMaven.

##I have a question

See if it's already been answered in the Discussion Group. If not, please ask there.

##I want to report a bug

First check the FAQ page for answers.

Then check the Changelog page to see if this issue is fixed in a newer or upcoming version of osmdroid.

If think you have a legitimate bug to report then go to the Issues page. If your issue already exists then contribute any additional information you may have that will help us track down the source of the issue. If your issue does not exist then create a new issue report. Include what version of osmdroid you are using, what version of Android you are using, a detailed description of the problem and any relevant code. It is particularly helpful if you can reproduce the problem using our OpenStreetMapViewer sample project as your starting point.

If you have a question on how to do something then your question is better suited for a public forum such as Stack Overflow or the osmdroid Google Groups page where you can get feedback from a large pool of osmdroid users.

##I want to contribute

Great! Osmdroid continues to improve from the contributions of its users. This could include code contributions, sample fragments for OpenStreetMapViewer, or wiki content. If you have an enhancement to contribute please add a new issue with a Type-Enhancement label. Describe the enhancement you are adding, how you implemented it and attach a patch against the latest trunk. Please take a look at the DeveloperGuidelines page for code contributions before submitting code.

##I want more!

Maybe take a look at the fine osmbonuspack project that acts as a companion to osmdroid and adds a lot of useful functionality.

##Screenshots