Skip to content

Commit

Permalink
Update integration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
devemux86 committed Sep 26, 2016
1 parent ff12785 commit 9c89315
Showing 1 changed file with 22 additions and 28 deletions.
50 changes: 22 additions & 28 deletions docs/Integration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Integration guide

This article describes how to integrate the library in your project. Check for current version at Maven badge on main page.
This article describes how to integrate the library in your project.

Current version is [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.mapsforge/mapsforge/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.mapsforge/mapsforge)

## Gradle

Expand All @@ -27,7 +29,7 @@ compile('org.mapsforge:mapsforge-map-android-extras:[CURRENT-VERSION]') {
}
```

#### Java
#### Desktop
```groovy
compile 'org.mapsforge:mapsforge-map-awt:[CURRENT-VERSION]'
compile 'com.kitfox.svg:svg-salamander:1.0'
Expand All @@ -49,12 +51,29 @@ compile 'org.mapsforge:spatialite-android:[CURRENT-VERSION]'

You'll need also the SpatiaLite native library [files](../spatialite-android/natives).

#### Java
#### Desktop
```groovy
compile 'org.mapsforge:mapsforge-poi-awt:[CURRENT-VERSION]'
compile 'org.xerial:sqlite-jdbc:3.8.11.2'
```

## Snapshots

We publish regularly SNAPSHOT builds to Sonatype OSS Repository Hosting.

You need to add the repository:
```groovy
repositories {
maven { url "https://oss.sonatype.org/content/repositories/snapshots/" }
}
```

And declare the dependencies like:
```groovy
compile 'org.mapsforge:mapsforge-core:master-SNAPSHOT'
...
```

## Maven

The dependencies for Maven are declared in a similar way. For example:
Expand All @@ -67,31 +86,6 @@ The dependencies for Maven are declared in a similar way. For example:
</dependency>
```

## Snapshots

We publish regularly SNAPSHOT builds to Sonatype OSS Repository Hosting. To use `master-SNAPSHOT` version add as repository, e.g. in Gradle:
```groovy
maven { url "https://oss.sonatype.org/content/repositories/snapshots/" }
```

## JitPack

We support also [JitPack](https://jitpack.io/#mapsforge/mapsforge) for releases or SNAPSHOT builds.

For example in order to include the `mapsforge-core` module `master-SNAPSHOT` with Gradle.

Add as repository:
```groovy
maven { url "https://jitpack.io" }
```

And declare as dependency:
```groovy
compile 'com.github.mapsforge.mapsforge:mapsforge-core:master-SNAPSHOT'
```

The same syntax applies for all modules. And with similar way you can declare the dependencies in Maven too.

## Jars

You can find jars (regular and with dependencies) in Maven Central or Snapshots repositories.
Expand Down

0 comments on commit 9c89315

Please sign in to comment.