From 349041360f35aa8dd806f7114ba7d9c3089c3db4 Mon Sep 17 00:00:00 2001 From: morgane Date: Thu, 11 Jan 2018 11:44:33 -0800 Subject: [PATCH 1/3] Remove redundant content --- documentation/docs/00-getting-started.md | 24 +--- documentation/docs/01-mapbox-api-token.md | 13 -- documentation/docs/02-known-issues.md | 2 - documentation/docs/03-examples.md | 120 ------------------ documentation/docs/04-attribution.md | 7 - documentation/docs/05-changelog.md | 2 +- .../docs/06-map-factory-framework.md | 27 ---- documentation/docs/hololens-development.md | 29 ----- documentation/docs/index.md | 4 - documentation/docs/toc.yml | 18 --- .../docs/windowsstore-uwp-hololens.md | 15 --- sdkproject/Assets/Mapbox/README.txt | 6 - .../Assets/Mapbox/Unity/MapboxAccess.cs | 3 +- 13 files changed, 3 insertions(+), 267 deletions(-) delete mode 100644 documentation/docs/01-mapbox-api-token.md delete mode 100644 documentation/docs/03-examples.md delete mode 100644 documentation/docs/04-attribution.md delete mode 100644 documentation/docs/06-map-factory-framework.md delete mode 100644 documentation/docs/hololens-development.md delete mode 100644 documentation/docs/windowsstore-uwp-hololens.md diff --git a/documentation/docs/00-getting-started.md b/documentation/docs/00-getting-started.md index e98b95438..21c7fc682 100644 --- a/documentation/docs/00-getting-started.md +++ b/documentation/docs/00-getting-started.md @@ -2,19 +2,7 @@ ## Installation from Unity Package -1. Visit https://www.mapbox.com/unity/ - -2. Click `Download the SDK` - -3. If you already have a Mapbox SDK imported in your project, please delete the existing `Mapbox` folder to avoid potential conflicts - -4. Import the package in Unity - - - Assets—>Import package—>Custom Package (from the Unity editor menu) - - **OR** - - - Double-click downloaded `.unityPackage` +Check out the official [Unity SDK page](https://www.mapbox.com/unity-sdk/) for installation steps. ## Installation from Git (source) @@ -22,17 +10,9 @@ 2. [Read about how the project is configured](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/README.md) and [learn how to contribute](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/CONTRIBUTING.md) 3. The actual Unity project is nested in the `sdkproject` directory -## Configure your Mapbox API Token - -You need an [access token](https://www.mapbox.com/help/define-access-token) to use your Mapbox account's capabilities. - -- [Get a Mapbox API token and add it to your Unity project](01-mapbox-api-token.md) - ## Next Steps - Follow along with [these tutorials](https://www.mapbox.com/unity-sdk/tutorials) -- Explore the [bundled Unity examples](03-examples.md) -- Learn about the [Map Factory Framework](06-map-factory-framework.md) - Read the [Unity/C# API documentation](https://www.mapbox.com/mapbox-unity-sdk/api/) ## Explore @@ -51,6 +31,4 @@ Before reporting issues or contacting support, please follow these steps: 2. Read about [Known Issues](02-known-issues.md) 3. Check our [public respository for existing issues](https://github.com/mapbox/mapbox-unity-sdk/issues) - - If you still need help, please [contact support](https://www.mapbox.com/contact/) or [create an issue](https://github.com/mapbox/mapbox-unity-sdk/issues). \ No newline at end of file diff --git a/documentation/docs/01-mapbox-api-token.md b/documentation/docs/01-mapbox-api-token.md deleted file mode 100644 index 94bfd6cb4..000000000 --- a/documentation/docs/01-mapbox-api-token.md +++ /dev/null @@ -1,13 +0,0 @@ -**An API token is required to access Mapbox services.** - -## Signup - - [Sign up for a free account.](https://www.mapbox.com/studio/signup/) - -## Configure API Access in Unity - -Copy your token from: https://www.mapbox.com/studio/account/tokens/. - -Click Mapbox—>Configure Access from the Unity Editor menu. Paste your token into the `Token` field. Assuming your token is valid, it will save to a text file in `StreamingAssets/MapboxAccess.text`. This file is ignored from the git repo to prevent contributors from accidentally comitting personal tokens. At runtime, the contents of this file will be read and cached for `FileSource` request purposes. See `MapboxAccess.cs` for details. - -Now that your access has been configured, check out [the included examples](https://www.mapbox.com/mapbox-unity-sdk/docs/03-examples.html). \ No newline at end of file diff --git a/documentation/docs/02-known-issues.md b/documentation/docs/02-known-issues.md index 857bcd964..7037ad252 100644 --- a/documentation/docs/02-known-issues.md +++ b/documentation/docs/02-known-issues.md @@ -4,8 +4,6 @@ - Minimum iOS version supported is 8 - Minimum Android version supported is 15 -- For UWP, please read these [special notes](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/documentation/docs/windowsstore-uwp-hololens.md). -- Hololens builds are currently not working as expected ### General diff --git a/documentation/docs/03-examples.md b/documentation/docs/03-examples.md deleted file mode 100644 index fa653e7aa..000000000 --- a/documentation/docs/03-examples.md +++ /dev/null @@ -1,120 +0,0 @@ -# Included Examples - -For each example, associated scripts and resources can be found in the same root directory as the scene itself. In addition to the bundled examples, you can find tutorials [here](https://www.mapbox.com/unity-sdk/tutorials/). - - - -## Explorer - -This is a master example that allows you to explore Mapbox’s location data and the Map Editor. You can see a variety of data layers associated with Mapbox’s vector tiles, including building data, points of interest (POIs), roads, and real-time traffic data. Each map vector tile includes high levels of detail about a particular location or building in GeoJSON format that you can leverage for procedurally generating experiences or styling. You can toggle these data layers on and off as needed in the Map Editor (access through the Mapbox menu). - -Mapbox has worldwide data coverage so you can create truly global game levels, AR experiences, and apps. Search anywhere in the world to explore the maps and location data you have available to you. - - - -## Globe - -This example demonstrates a procedurally generated globe model leveraging Mapbox’s global coverage map data. The custom markers showcase how to drop pins according to exact world coordinates. The example also uses a special terrain factor that spherically projects our square tiles onto the globe. - - - -## LocationProvider: A Location-based Game or App Template - -This is a starting point for a location-based game or app. We’re dropping a pin at your location on a 2D map that includes building data outlines and other procedurally generated geo features from Mapbox’s data that you can toggle and style as needed. We’ve created a fun map style in Mapbox Studio for this example - and so can you. This example also includes an update that allows you to zoom in and out, and the map updates accordingly. - - - -## Playground Example Set - -### PlayGround > Directions -This example showcases leveraging Mapbox’s Search and Navigation APIs in Unity to get directions worldwide. - -Enter a start location query (eg. "San Francisco, CA"), this is a forward geocode request. Then enter a destination query (eg. "Los Angeles, CA"), this is also a forward geocode request. - -When the geocode requests have been completed, a directions request is executed. A new request is sent every time the start or destination user input fields are edited. - -Directions results will be logged to the UI when they are available (in the form of JSON). - - - -### PlayGround > Forward Geocoder - -This example showcases leveraging Mapbox’s Search API to do a forward geocoding request, which means querying a place by name and getting all of its GeoJSON data. A new request is sent every time the user input field is edited. - -Visit Mapbox’s API documentation for more information. - - - -### PlayGround > RasterTile - -Uses a forward geocoder request (search a location by name, not coordinates) to fetch a styled raster tile from. You can change the map styling in the dropdown (and import your own through Mapbox Studio) . A new request is sent whenever the zoom or style are changed, or when the user input field is edited. - -See: https://www.mapbox.com/help/define-style/ -See: https://www.mapbox.com/api-documentation/#retrieve-raster-tiles-from-styles - - - -### PlayGround > Reverse Geocoder - -This example showcases leveraging Mapbox’s Search API to do a reverse geocoding request, which means querying a place by latitude and longitude string to get all of the features associated with that location. A new request is sent every time the user input field is edited. - -Visit Mapbox’s API documentation for more information. - - - -### PlayGround > Vector Tile - -This example shows using a forward geocoder request (search by location name, not coordinates) to fetch a vector tile. You can leverage vector tile data to do things like procedurally generate decorations or experiences based on building heights, land features, etc. In this example, the result is printed as GeoJSON with a feature collection. A new request is sent whenever the user input field is edited. - -Visit Mapbox’s API documentation for more information. - - - -## VectorTileMaps Example Set - -### VectorTileMaps > BasicVectorMap: 3D Buildings from Vector Tile Data -This example shows how we extrude 3D buildings from the building height data contained in a vector tile. Mapbox’s vector tiles include a wide array of data about locations that you can leverage. - - - -### VectorTileMaps > InteractiveStyledVectorMap: Styling Based on Vector Tile Data - -This is a vector tile map where you can interact with individual buildings to show their associated information (contained in the vector tile). This example also shows how to procedurally decorate land use and how to render building types differently based on their classification. - - - -### VectorTileMaps > PoiVectorMap: Points of Interest - -This is a vector tile map showcasing Point of Interest (`poi_label`) markers. Mapbox’s (streets-v7) vector tile set includes POIs you can leverage or you can import your own custom data sets to create custom POIs through Mapbox Studio. - - - -### VectorTileMaps > TerrainVectorMap: Vector Data on Top of 3D Terrain - -This is a vector tile map with terrain data turned on (we use a separate terrain factory and then we snap vector tile features to the extruded terrain mesh). Mapbox has worldwide terrain data coverage. You can also use terrain data with raster tiles to superimpose satellite imagery over the elevation data to create real world elevation models. - - - -## VoxelMap: Real World Data, Minecraft-inspired Map - -## VoxelMap: Real World Data, Minecraft-inspired Map -This Minecraft-inspired example demonstrates a less traditional way to consume Mapbox data for maps or world construction. - -VoxelTile is responsible for fetching both a styled raster tile and a mapbox.terrain-rgb (global elevation) tile. The styled raster pixels are sampled to determine which voxels to generate, via the VoxelFetcher. This is achieved using a nearest color formula. The elevation tile pixels are sampled to determine where to vertically place the voxels. - -Zoom: the zoom level at which to request the tiles. - -Elevation Multiplier: used to exaggerate the real-world height. - -Voxel Depth Padding: determine how many voxels to spawn below the designated height. This helps fill holes in environments with extreme elevation variations. - -Tile Width in Voxels: How many voxels to generate across each tile. This will affect the detail of the world. Raster textures are downsampled according to this value. - -Voxel Batch Count: The number of voxels to spawn at once. Keep this number low to prevent locking the main thread during construction. - - - -## ZoomableMap: Worldwide Dynamic Zoom & Panning Support - -This example is a starting point for creating a traditional web-based zoomable map. Go anywhere in the world and check out Mapbox’s high-quality satellite imagery. - diff --git a/documentation/docs/04-attribution.md b/documentation/docs/04-attribution.md deleted file mode 100644 index e34d2a769..000000000 --- a/documentation/docs/04-attribution.md +++ /dev/null @@ -1,7 +0,0 @@ -## Attribution - -All uses of Mapbox’s custom maps and data must attribute both Mapbox and the appropriate data providers. Mapbox’s custom design is copyrighted and our data sources require attribution. This requirement extends to all plan levels. - -You must include the the [Mapbox wordmark and attribution notice](https://www.mapbox.com/help/attribution/) on any map that uses the Mapbox Maps SDK for Unity. We provide with the SDK an `Attribution` prefab that includes all required information. This prefab utilizes UGUI for integration and customization. You may adjust the position of the Mapbox wordmark and attribution notice (pivots and anchors of the rect transform), but they must remain visible on the map. You may also change the background color of the rect transform and the text color of the text attribution notice to best match your design aesthetics, but all information must be clearly legible. You may not otherwise alter the Mapbox wordmark or text attribution notice. If you wish to otherwise relocate or to remove the Mapbox wordmark, please contact our [sales team](mailto:sales@mapbox.com) to discuss options available under our Enterprise plans. - -[Read more on our website](https://www.mapbox.com/help/attribution/). \ No newline at end of file diff --git a/documentation/docs/05-changelog.md b/documentation/docs/05-changelog.md index d167208d2..f32ad0890 100644 --- a/documentation/docs/05-changelog.md +++ b/documentation/docs/05-changelog.md @@ -124,7 +124,7 @@ - `MapId` and `Factories` are now public so that you can change them at runtime. ##### New Examples -- [See here for the latest.](https://www.mapbox.com/mapbox-unity-sdk/docs/03-examples.html) +- [See here for the latest.](https://www.mapbox.com/unity-sdk) ### v.1.1.0 diff --git a/documentation/docs/06-map-factory-framework.md b/documentation/docs/06-map-factory-framework.md deleted file mode 100644 index 3eec46a92..000000000 --- a/documentation/docs/06-map-factory-framework.md +++ /dev/null @@ -1,27 +0,0 @@ -# Map Factory Framework - -This framework allows you to create and style your maps through factory and visualization abstractions. The system is intended to be designer-friendly by serializing configuration settings in `ScriptableObjects`. - -## Map Controller - -Not a part of the Map Visualization structure but respresents the rest of the application and requests tiles from Map Visualization. - -## Map Visualization - -Core class of the visualization tree, keeps and manages the factories. - -###Factories - -Factories are wrappers around Mapbox Api end points like raster image or vector data. - -####[Terrain Factory](MeshGeneration/Factories/TerrainFactory.md) - -Factory responsible for creating the world base. - -####[Map Image Factory](MeshGeneration/Factories/MapImageFactory.md) - -Factory responsible for assigning materials and textures to the world base mesh. - -####[Mesh Factory](MeshGeneration/Factories/MeshFactory.md) - -Factory responsible for the visualization of vector data. \ No newline at end of file diff --git a/documentation/docs/hololens-development.md b/documentation/docs/hololens-development.md deleted file mode 100644 index 5467e1163..000000000 --- a/documentation/docs/hololens-development.md +++ /dev/null @@ -1,29 +0,0 @@ -# HoloLens development - -> [!NOTE] -> Refer to [Exporting to Windows Store (UWP, HoloLens)](windowsstore-uwp-hololens.md) to meet the `sqlite3` requirement for `Windows Store` solutions. - -HoloLens requires code/assemblies to work with [Universal Windows Platform (UWP)](https://developer.microsoft.com/en-us/windows/apps). - -Reference: [dev.microsoft.com: Unity development overview, Configuring a Unity project for HoloLens](https://developer.microsoft.com/en-us/windows/holographic/unity_development_overview) - * **`Main Camera`** - * has to be named **`Main Camera`** 😏 - * `Main Camera` has to be positioned at `0,0,0` - * set `Clear Flags` to `Solid Color` - * change the `Background color` to `RGBA 0,0,0,0` - * Change `Clipping Planes - Near` to the HoloLens recommended **0.85 (meters)** - ![image](images/hololens/hololens-main-camera.png) - - * File -> Build Settings -> Windows Store - * `SDK` => `Universal 10` - * `Build Type` => `D3D` - * `Player Settings` => `Settings for Windows Store` tab - * `Other Settings` => `Rendering`: - * **!!!check checkbox `Virtual Reality Supported` to add a new `Virtual Reality Devices` list and confirm `Windows Holographic` is listed as supported device!!** - * `Publish Settings` => `Capabilities`: - * check `SpatialPerception` - * **!!!check `InternetClient`!!!** - - * Edit -> Project Settings -> Quality - * select dropdown under `Windows Store` logo to `Fastest` - ![image](images/hololens/hololens-projectsettings-qualitysettings.png) \ No newline at end of file diff --git a/documentation/docs/index.md b/documentation/docs/index.md index ceab7642b..978ada486 100644 --- a/documentation/docs/index.md +++ b/documentation/docs/index.md @@ -38,12 +38,8 @@ footer{ Quick start links:
diff --git a/documentation/docs/toc.yml b/documentation/docs/toc.yml index 685e9f843..04574472c 100644 --- a/documentation/docs/toc.yml +++ b/documentation/docs/toc.yml @@ -1,26 +1,8 @@ - name: Getting Started href: 00-getting-started.md -- name: Mapbox API Token - href: 01-mapbox-api-token.md - - name: Known Issues href: 02-known-issues.md -- name: Examples - href: 03-examples.md - -- name: Attribution - href: 04-attribution.md - - name: Changelog href: 05-changelog.md - -- name: Map Factory Framework - href: 06-map-factory-framework.md - -- name: Windows Store, UWP, HoloLens - href: windowsstore-uwp-hololens.md - -- name: HoloLens Development - href: hololens-development.md \ No newline at end of file diff --git a/documentation/docs/windowsstore-uwp-hololens.md b/documentation/docs/windowsstore-uwp-hololens.md deleted file mode 100644 index c1cc96738..000000000 --- a/documentation/docs/windowsstore-uwp-hololens.md +++ /dev/null @@ -1,15 +0,0 @@ -# Exporting to Windows Store (UWP, HoloLens) - -This SDK has a dependency on `sqlite` which has to be installed seperately after building the `Windows Store` solution: - -* Open exported `Windows Store` solution -* `Tools -> Extensions and Updates` - * Search for `sqlite` - * Install `SQLite for Universal Windows Platform` -* Right click on `References` of the default project - * `Add Reference` - * Expand `Universal Windows` on the left - * Click `Extensions` - * Check `SQLite for Universal Windows Platform` - -The `Windows Store` solution should build successfully now. diff --git a/sdkproject/Assets/Mapbox/README.txt b/sdkproject/Assets/Mapbox/README.txt index d52fb4bcc..006b591be 100644 --- a/sdkproject/Assets/Mapbox/README.txt +++ b/sdkproject/Assets/Mapbox/README.txt @@ -3,16 +3,10 @@ Thank you for downloading the Mapbox Unity SDK (for Unity 2017.1+)! Getting started: https://www.mapbox.com/mapbox-unity-sdk/docs/00-getting-started.html -Configuring your API token: https://www.mapbox.com/mapbox-unity-sdk/docs/01-mapbox-api-token.html - Tutorials: https://www.mapbox.com/unity-sdk/tutorials/ -Built-in Examples: https://www.mapbox.com/mapbox-unity-sdk/docs/03-examples.html - Known Issues: https://www.mapbox.com/mapbox-unity-sdk/docs/02-known-issues.html -Attribution: https://www.mapbox.com/mapbox-unity-sdk/docs/04-attribution.html - API: https://www.mapbox.com/mapbox-unity-sdk/api/ diff --git a/sdkproject/Assets/Mapbox/Unity/MapboxAccess.cs b/sdkproject/Assets/Mapbox/Unity/MapboxAccess.cs index f01867dba..bd261ef87 100644 --- a/sdkproject/Assets/Mapbox/Unity/MapboxAccess.cs +++ b/sdkproject/Assets/Mapbox/Unity/MapboxAccess.cs @@ -44,8 +44,7 @@ public static MapboxAccess Instance MapboxConfiguration _configuration; /// - /// The Mapbox API access token. - /// See Mapbox API Congfiguration in Unity. + /// The Mapbox API access token. /// public MapboxConfiguration Configuration { From b4cf2e6792295a50799b59dc8c154f620c4315d1 Mon Sep 17 00:00:00 2001 From: morgane Date: Wed, 17 Jan 2018 15:10:02 -0800 Subject: [PATCH 2/3] Re-include deleted pages --- documentation/docs/02-known-issues.md | 4 +-- documentation/docs/hololens-development.md | 29 +++++++++++++++++++ documentation/docs/index.md | 19 ++++++------ documentation/docs/toc.yml | 8 ++++- .../docs/windowsstore-uwp-hololens.md | 15 ++++++++++ 5 files changed, 63 insertions(+), 12 deletions(-) create mode 100644 documentation/docs/hololens-development.md create mode 100644 documentation/docs/windowsstore-uwp-hololens.md diff --git a/documentation/docs/02-known-issues.md b/documentation/docs/02-known-issues.md index 7037ad252..268046bd9 100644 --- a/documentation/docs/02-known-issues.md +++ b/documentation/docs/02-known-issues.md @@ -4,6 +4,8 @@ - Minimum iOS version supported is 8 - Minimum Android version supported is 15 +- For UWP, please read these [special notes](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/documentation/docs/windowsstore-uwp-hololens.md). +- Hololens builds are currently not working as expected ### General @@ -32,5 +34,3 @@ ### Tile Error Callbacks - When a client sends a `Cancel()` / `Recycle()` request to a `UnityTile` instance, the `OnTileError` event handler method is unsubscribed from the `OnTileError` event. Followed by that, a "request aborted" exception is sent as a part of the response to the requested `Tile`. But, the `UnityTile` instance cannot listen to this exception since, it has already unsubscribed from the `OnTileError` event - - diff --git a/documentation/docs/hololens-development.md b/documentation/docs/hololens-development.md new file mode 100644 index 000000000..a9f7328f8 --- /dev/null +++ b/documentation/docs/hololens-development.md @@ -0,0 +1,29 @@ +# HoloLens development + +-> [!NOTE] +-> Refer to [Exporting to Windows Store (UWP, HoloLens)](windowsstore-uwp-hololens.md) to meet the `sqlite3` requirement for `Windows Store` solutions. + +HoloLens requires code/assemblies to work with [Universal Windows Platform (UWP)](https://developer.microsoft.com/en-us/windows/apps). + +Reference: [dev.microsoft.com: Unity development overview, Configuring a Unity project for HoloLens](https://developer.microsoft.com/en-us/windows/holographic/unity_development_overview) + * **`Main Camera`** + * has to be named **`Main Camera`** 😏 + * `Main Camera` has to be positioned at `0,0,0` + * set `Clear Flags` to `Solid Color` + * change the `Background color` to `RGBA 0,0,0,0` + * Change `Clipping Planes - Near` to the HoloLens recommended **0.85 (meters)** + ![image](images/hololens/hololens-main-camera.png) + + * File -> Build Settings -> Windows Store + * `SDK` => `Universal 10` + * `Build Type` => `D3D` + * `Player Settings` => `Settings for Windows Store` tab + * `Other Settings` => `Rendering`: + * **!!!check checkbox `Virtual Reality Supported` to add a new `Virtual Reality Devices` list and confirm `Windows Holographic` is listed as supported device!!** + * `Publish Settings` => `Capabilities`: + * check `SpatialPerception` + * **!!!check `InternetClient`!!!** + + * Edit -> Project Settings -> Quality + ![image](images/hololens/hololens-projectsettings-qualitysettings.png) + * select dropdown under `Windows Store` logo to `Fastest` diff --git a/documentation/docs/index.md b/documentation/docs/index.md index 978ada486..8d4ad2755 100644 --- a/documentation/docs/index.md +++ b/documentation/docs/index.md @@ -35,15 +35,16 @@ footer{

-Quick start links:
-

    -
  • [Getting started](00-getting-started.md)

    • -
  • [Changelog](05-changelog.md)

    • -
  • [Known issues](02-known-issues.md)

    • -
  • [API Documentation](api/)

    • -
- -

+ Quick start links:
+
    +
  • [Getting started](00-getting-started.md)

    • +
  • [Changelog](05-changelog.md)

    • +
  • [Known issues](02-known-issues.md)

    • +
  • [API Documentation](api/)

    • +
  • [Unity SDK page](https://www.mapbox.com/unity-sdk/)
    • +
+ +

diff --git a/documentation/docs/toc.yml b/documentation/docs/toc.yml index 04574472c..9d8309381 100644 --- a/documentation/docs/toc.yml +++ b/documentation/docs/toc.yml @@ -5,4 +5,10 @@ href: 02-known-issues.md - name: Changelog - href: 05-changelog.md + href: 05-changelog.md + +- name: Windows Store, UWP, HoloLens + href: windowsstore-uwp-hololens.md + +- name: HoloLens Development + href: hololens-development.md diff --git a/documentation/docs/windowsstore-uwp-hololens.md b/documentation/docs/windowsstore-uwp-hololens.md new file mode 100644 index 000000000..ba1deb62c --- /dev/null +++ b/documentation/docs/windowsstore-uwp-hololens.md @@ -0,0 +1,15 @@ +# Exporting to Windows Store (UWP, HoloLens) + +This SDK has a dependency on `sqlite` which has to be installed seperately after building the `Windows Store` solution: + +* Open exported `Windows Store` solution +* `Tools -> Extensions and Updates` + * Search for `sqlite` + * Install `SQLite for Universal Windows Platform` +* Right click on `References` of the default project + * `Add Reference` + * Expand `Universal Windows` on the left + * Click `Extensions` + * Check `SQLite for Universal Windows Platform` + +The `Windows Store` solution should build successfully now. \ No newline at end of file From 401b68db5dd5d380d0ef3d64a31abddcd35111e0 Mon Sep 17 00:00:00 2001 From: Morgane Santos Date: Fri, 19 Jan 2018 14:44:04 -0800 Subject: [PATCH 3/3] Add extra step to run the update script --- documentation/docs/00-getting-started.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/documentation/docs/00-getting-started.md b/documentation/docs/00-getting-started.md index 21c7fc682..873a36ccb 100644 --- a/documentation/docs/00-getting-started.md +++ b/documentation/docs/00-getting-started.md @@ -7,8 +7,9 @@ Check out the official [Unity SDK page](https://www.mapbox.com/unity-sdk/) for i ## Installation from Git (source) 1. `git clone https://github.com/mapbox/mapbox-unity-sdk.git` -2. [Read about how the project is configured](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/README.md) and [learn how to contribute](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/CONTRIBUTING.md) -3. The actual Unity project is nested in the `sdkproject` directory +2. [Run the update script](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/README.md#from-this-repository-advanced-latest-development). +3. [Read about how the project is configured](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/README.md) and [learn how to contribute](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/CONTRIBUTING.md) +4. The actual Unity project is nested in the `sdkproject` directory ## Next Steps @@ -31,4 +32,4 @@ Before reporting issues or contacting support, please follow these steps: 2. Read about [Known Issues](02-known-issues.md) 3. Check our [public respository for existing issues](https://github.com/mapbox/mapbox-unity-sdk/issues) -If you still need help, please [contact support](https://www.mapbox.com/contact/) or [create an issue](https://github.com/mapbox/mapbox-unity-sdk/issues). \ No newline at end of file +If you still need help, please [contact support](https://www.mapbox.com/contact/) or [create an issue](https://github.com/mapbox/mapbox-unity-sdk/issues).