diff --git a/README.md b/README.md index 7d30a091..a195925a 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@ [![Build Status](https://travis-ci.org/mapsforge/vtm.svg?branch=master)](https://travis-ci.org/mapsforge/vtm) [![GitHub license](https://img.shields.io/badge/license-LGPL3-blue.svg)](COPYING.LESSER) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.mapsforge/vtm/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.mapsforge/vtm) # V™ VTM was developed within the [OpenScienceMap](http://opensciencemap.org) project. -**This fork is for continue VTM development and make it compatible with latest [Mapsforge](https://github.com/mapsforge/mapsforge).** +**This fork is for continue VTM development. And make it compatible with latest [Mapsforge](https://github.com/mapsforge/mapsforge).** -If you have any questions or problems, don't hesitate to ask our public [mailing list](https://groups.google.com/group/mapsforge-dev) for help. You can also report bugs and improvement requests via our [issue tracker](https://github.com/mapsforge/vtm/issues). And read through [how to contribute](.github/CONTRIBUTING.md) guidelines. +See the [integration guide](docs/Integration.md). If you have any questions or problems, don't hesitate to ask our public [mailing list](https://groups.google.com/group/mapsforge-dev) for help. You can also report bugs and improvement requests via our [issue tracker](https://github.com/mapsforge/vtm/issues). And read through [how to contribute](.github/CONTRIBUTING.md) guidelines. ## Features - Java map library @@ -20,7 +21,7 @@ If you have any questions or problems, don't hesitate to ask our public [mailing - bitmap: any quadtree-scheme tiles as texture - Backends: - Android (optional libGDX) - - iOS (using libGDX/RoboVM) ([instructions](docs/ios.md)) + - iOS (using libGDX/RoboVM, [instructions](docs/ios.md)) - Desktop (using libGDX/JGLFW) - HTML5/WebGL (using libGDX/GWT) @@ -29,7 +30,7 @@ If you have any questions or problems, don't hesitate to ask our public [mailing - **vtm-android** Android backend (no libGDX required) - **vtm-android-example** provides examples using **vtm-android** - **vtm-gdx** common libGDX backend -- **vtm-android-gdx** Android application (with libGDX) +- **vtm-android-gdx** Android backend (with libGDX) - **vtm-desktop** Desktop backend - **vtm-ios** iOS backend - **vtm-web** HTML5/GWT backend @@ -38,7 +39,7 @@ If you have any questions or problems, don't hesitate to ask our public [mailing The libGDX backend for GWT is experimental. ## Master build downloads -- [Latest jars and Samples applications](http://ci.mapsforge.org/job/vtm/) +- [Latest jars and samples](http://ci.mapsforge.org/job/vtm/) ## WebGL Demo [OpenScienceMap](http://opensciencemap.org/s3db/#scale=17,rot=61,tilt=51,lat=53.075,lon=8.807) view of Bremen. @@ -46,7 +47,7 @@ The libGDX backend for GWT is experimental. ## Credits This library contains code from several projects: -- **mapsforge**: based on 0.2.4 (http://mapsforge.org) +- **mapsforge**: based on 0.2.4 (https://github.com/mapsforge/mapsforge) - **osmdroid**: some overlay classes (https://github.com/osmdroid/osmdroid) - **libGDX**: AsyncTask, MathUtils and Interpolation classes (https://github.com/libgdx) - **Android**: some Matrix code, TimSort (http://source.android.com) diff --git a/docs/Integration.md b/docs/Integration.md new file mode 100644 index 00000000..73e45d56 --- /dev/null +++ b/docs/Integration.md @@ -0,0 +1,73 @@ +# Integration guide + +This article describes how to integrate the library in your project. Check for current version at Maven badge on main page. + +## Gradle + +### Core +```groovy +compile 'org.mapsforge:vtm:[CURRENT-VERSION]' +compile 'org.mapsforge:vtm-themes:[CURRENT-VERSION]' +compile 'org.slf4j:slf4j-api:1.7.21' +compile 'org.slf4j:slf4j-simple:1.7.21' +``` + +### Android +```groovy +compile 'org.mapsforge:vtm-android:[CURRENT-VERSION]' +compile 'org.mapsforge:vtm-android:[CURRENT-VERSION]:natives-armeabi' +compile 'org.mapsforge:vtm-android:[CURRENT-VERSION]:natives-armeabi-v7a' +compile 'org.mapsforge:vtm-android:[CURRENT-VERSION]:natives-x86' +compile 'com.caverock:androidsvg:1.2.2-beta-1' +``` + +### Java +```groovy +compile 'org.mapsforge:vtm-gdx:[CURRENT-VERSION]' +compile 'org.mapsforge:vtm-desktop:[CURRENT-VERSION]' +compile 'org.mapsforge:vtm-desktop:[CURRENT-VERSION]:natives-linux' +compile 'org.mapsforge:vtm-desktop:[CURRENT-VERSION]:natives-osx' +compile 'org.mapsforge:vtm-desktop:[CURRENT-VERSION]:natives-windows' +compile 'com.badlogicgames.gdx:gdx:1.9.3' +compile 'com.badlogicgames.gdx:gdx-platform:1.9.3:natives-desktop' +compile 'com.badlogicgames.gdx:gdx-backend-jglfw:1.9.3' +compile 'com.badlogicgames.jglfw:jglfw:1.1' +compile 'com.badlogicgames.jglfw:jglfw-platform:1.1:natives-desktop' +compile 'com.kitfox.svg:svg-salamander:1.0' +``` + +## Maven + +The dependencies for Maven are declared in a similar way. For example: + +```xml + + org.mapsforge + vtm + [CURRENT-VERSION] + +``` + +## JitPack + +We support also [JitPack](https://jitpack.io/#mapsforge/vtm) for publishing. This can be used for the releases, but it's also useful for integrating SNAPSHOT builds in your application (not available in Maven Central). + +For example in order to include the `vtm` module `master-SNAPSHOT` with Gradle. + +Add as repository: +```groovy +maven { url "https://jitpack.io" } +``` + +And declare as dependency: +```groovy +compile 'com.github.mapsforge.vtm:vtm: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 our [Jenkins CI server](http://ci.mapsforge.org/). + +Third party jars can be found at their respective sites or in Maven Central repository.