From ec710bb0f697c6084e4a56fb12b43983f809b2d9 Mon Sep 17 00:00:00 2001 From: Siyu Date: Mon, 1 May 2017 00:04:33 -0700 Subject: [PATCH 1/4] Update README.md - removed build package info - added basic information --- README.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 36ea55b94..ac4e169a8 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,19 @@ # mapbox-sdk-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-sdk-unity/blob/master/CONTRIBUTING.md). -Tools for using Mapbox with Unity. -## 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 +# Docs +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 From 70542f9a5398222399df68eb1f2cbbb5d9a53c2f Mon Sep 17 00:00:00 2001 From: Siyu Date: Mon, 1 May 2017 00:04:58 -0700 Subject: [PATCH 2/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ac4e169a8..0e64377ce 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ This repo contains: - DocFX project for generateing API documentation - Written manuals and guides -# Docs +# Documentation Documentation is generated using DocFX from this repo and is hosted at: https://www.mapbox.com/mapbox-unity-sdk/ # Dependencies From dfeba226bd09ad156a3acb8af3952a7b1fb20f82 Mon Sep 17 00:00:00 2001 From: David Rhodes Date: Mon, 1 May 2017 08:46:00 -0600 Subject: [PATCH 3/4] Updating main title and proper link to contributing guide --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0e64377ce..226976023 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# 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 APIs with C# / Unity. If you'd like to contribute to the project, [read CONTRIBUTING.md](https://github.com/mapbox/mapbox-unity-sdk/blob/master/CONTRIBUTING.md). This repo contains: - Unity specific tools and libraries for processing Mapbox data @@ -9,7 +9,7 @@ This repo contains: - Written manuals and guides # Documentation -Documentation is generated using DocFX from this repo and is hosted at: https://www.mapbox.com/mapbox-unity-sdk/ +Documentation is generated using DocFX from this repo and is hosted at: https://www.mapbox.com/mapbox-unity-sdk/. # Dependencies This project includes git submodule dependcies outline in [this gitmodules](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/.gitmodules) file. From a5b69e631d6cbe370883cdc81f0c69bab397fe03 Mon Sep 17 00:00:00 2001 From: David Rhodes Date: Mon, 1 May 2017 08:54:44 -0600 Subject: [PATCH 4/4] pointing to develop instead of master for contributing link --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 226976023..b4f85e6c4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # 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-unity-sdk/blob/master/CONTRIBUTING.md). +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). This repo contains: - Unity specific tools and libraries for processing Mapbox data @@ -15,5 +15,5 @@ Documentation is generated using DocFX from this repo and is hosted at: https:// This project includes git submodule dependcies outline in [this gitmodules](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/.gitmodules) file. These repos are actively developed and maintained: -https://github.com/mapbox/vector-tile-cs -https://github.com/mapbox/mapbox-sdk-cs +- https://github.com/mapbox/vector-tile-cs +- https://github.com/mapbox/mapbox-sdk-cs