Update documentation

This commit is contained in:
Emux 2016-07-04 10:42:50 +03:00
parent 7a1d56d888
commit 59f74664a2
2 changed files with 13 additions and 47 deletions

View File

@ -2,7 +2,6 @@
[![GitHub license](https://img.shields.io/badge/license-LGPL3-blue.svg)](COPYING.LESSER)
# V™
<br/>
VTM was developed within the [OpenScienceMap](http://opensciencemap.org) project.
@ -20,55 +19,27 @@ If you have any questions or problems, don't hesitate to ask our public [mailing
- GeoJSON tiles
- bitmap: any quadtree-scheme tiles as texture
- Backends:
- Android
- Desktop (using libgdx/LwjGL)
- HTML5/WebGL (using libgdx/GWT)
- iOS (using libgdx/robovm)
- Android (optional libGDX)
- iOS (using libGDX/RoboVM)
- Desktop (using libGDX/JGLFW)
- HTML5/WebGL (using libGDX/GWT)
### Projects
- **vtm** contains the core library
- **vtm-android** Android backend (no libgdx required)
- **vtm-android** Android backend (no libGDX required)
- **vtm-android-example** provides examples using **vtm-android**
- **vtm-gdx** common libgdx backend code
- **vtm-android-gdx** Android application
- **vtm-desktop** Desktop application
- **vtm-gdx** common libGDX backend
- **vtm-android-gdx** Android application (with libGDX)
- **vtm-desktop** Desktop backend
- **vtm-ios** iOS backend
- **vtm-web** HTML5/GWT backend
- **vtm-web-app** HTML5/GWT application
- **vtm-ios** iOS application
The libgdx backends for GWT and iOS are very experimental.
### Master build downloads
The libGDX backends for iOS and GWT are experimental.
## Master build downloads
- [Latest jars and Samples applications](http://ci.mapsforge.org/job/vtm/)
## Getting started
`git clone --recursive https://github.com/mapsforge/vtm`
Install Android SDK and build-tools 20.0. From extras add
'Android Support Library/Repository' and 'Google Repository'.
The commands below should set things up correctly when Android
SDK is already installed.
```
export ANDROID_HOME=/path/to/your/android-sdk
./android-stuff.sh
```
### Eclipse
`./gradlew eclipse`<br/>
Import all 'vtm' sub-projects into Eclipse.
### Android-Studio
Just import build.gradle
### Gradle
You can run gradle tasks directly (see also `./gradlew -q tasks`):<br/>
`./gradlew clean install` <br/> to build the libraries and add them to the local maven repository.<br/>
`./gradlew :vtm-android-example:run` <br/> to run the android example<br/>
`./gradlew :vtm-desktop:run` <br/>to run the desktop demo (only Linux64 and Win64 native libs are provided atm)<br/>
`./gradlew :vtm-web-app:jettyDraftWar` <br/>to run the webgl demo<br/>
## WebGL Demo
[OpenScienceMap](http://opensciencemap.org/s3db/#scale=17,rot=61,tilt=51,lat=53.075,lon=8.807) view of Bremen.
- hold right mouse button to change view direction
@ -76,7 +47,7 @@ You can run gradle tasks directly (see also `./gradlew -q tasks`):<br/>
## Credits
This library contains code from several projects:
- **mapsforge**: based on 0.2.4 (http://mapsforge.org)
- **osmdroid**: some overlay classes (http://code.google.com/p/osmdroid/)
- **libgdx**: AsyncTask, MathUtils and Interpolation classes (https://github.com/libgdx)
- **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)
- **tessellate**: (https://github.com/cscheid/tessellate)

View File

@ -1,5 +0,0 @@
VectorTileMap is part of the OpenScienceMap project, developed at University of Bremen.
http://www.opensciencemap.org
To build the eclipse project the android ndk plugin is required.