From dc15ba5f34f8584506360266b17391105656ae7d Mon Sep 17 00:00:00 2001 From: Emux Date: Wed, 2 Nov 2016 10:02:34 +0200 Subject: [PATCH] Update documentation --- README.md | 11 ++++++----- docs/Integration.md | 4 ++-- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7ac43816..466b3d41 100644 --- a/README.md +++ b/README.md @@ -8,19 +8,20 @@ VTM was developed within the [OpenScienceMap](https://github.com/opensciencemap) **This fork continues VTM development. And provides compatibility 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. +See the **[integration guide](docs/Integration.md)** and [changelog](docs/Changelog.md). And read through [how to contribute](.github/CONTRIBUTING.md) guidelines. -See the [integration guide](docs/Integration.md) and [changelog](docs/Changelog.md). And read through [how to contribute](.github/CONTRIBUTING.md) guidelines. +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. ## Features - Java map library - OpenGL vector-tile rendering - Themeable vector layers - Support for multiple tile sources: - - primary opensciencemap (.vtm) - - mapsforge files + - OpenScienceMap (.vtm) + - Mapsforge (.map) + - Mapbox tiles (.mvt) - GeoJSON tiles - - bitmap: any quadtree-scheme tiles as texture + - Raster tiles: any quadtree-scheme tiles as texture - Backends: - Android (optional libGDX) - iOS (using libGDX/RoboVM, [instructions](docs/ios.md)) diff --git a/docs/Integration.md b/docs/Integration.md index 171c46b1..ba3416f0 100644 --- a/docs/Integration.md +++ b/docs/Integration.md @@ -1,6 +1,6 @@ # Integration guide -This article describes how to integrate the library in your project. +This article describes how to integrate the library in your project, with Gradle / Maven / Jars or use SNAPSHOT builds. Current version is [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.mapsforge/vtm/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.mapsforge/vtm) @@ -74,6 +74,6 @@ The dependencies for Maven are declared in a similar way. For example: ## Jars -You can find jars (regular and with dependencies) in Maven Central or Snapshots repositories. +You can find release and snapshot jars (regular and with dependencies) in [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.mapsforge%22) and [Sonatype OSS Repository Hosting](https://oss.sonatype.org/content/repositories/snapshots/org/mapsforge/). Third party jars can be found at their respective sites or in Maven Central repository.