Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 14 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@
# mapbox-sdk-unity
# Mapbox-unity-sdk

Tools for using Mapbox APIs with C# / Unity. If you'd like to contribute to the project, [read CONTRIBUTING.md](https://github.com/mapbox/mapbox-sdk-unity/blob/master/CONTRIBUTING.md).
Tools for using Mapbox with Unity.
Tools for using Mapbox APIs with C# / Unity. If you'd like to contribute to the project, [read CONTRIBUTING.md](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/CONTRIBUTING.md).

## Build `unitypackage`
This repo contains:
- Unity specific tools and libraries for processing Mapbox data
- Example projects using Mapbox Unity SDK
- DocFX project for generateing API documentation
- Written manuals and guides

### On AppVeyor
# Documentation
Documentation is generated using DocFX from this repo and is hosted at: https://www.mapbox.com/mapbox-unity-sdk/.

- change version of `MapboxSDKforUnityCore` in `packages.config` to the one needed
- push
- AppVeyor creates the `unitypackage` and it can be downloaded from the `Artifacts` tab, eg https://ci.appveyor.com/project/Mapbox/mapbox-sdk-unity/build/1.0.215/artifacts
# Dependencies
This project includes git submodule dependcies outline in [this gitmodules](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/.gitmodules) file.

### Locally (currently Windows only)

- run `update-mapbox-unity-sdk-core.bat`:
- eg `update-mapbox-unity-sdk-core.bat 1.0.0-alpha07`
- this write a new `packages.config`
- install the package
- copies its content into `sdkproject`
- run `UnityPackager.exe unitypackage.config sdkproject\Assets\ mapbox-unity-sdk_LATEST.unitypackage`
These repos are actively developed and maintained:
- https://github.com/mapbox/vector-tile-cs
- https://github.com/mapbox/mapbox-sdk-cs