Skip to content

Commit 6496746

Browse files
authored
Merge pull request #4050 from wiwei/docfixes
Clean up delivery mechanism documentation.
2 parents 59a2ffc + d925d91 commit 6496746

File tree

2 files changed

+10
-24
lines changed

2 files changed

+10
-24
lines changed

Documentation/DownloadingTheMRTK.md

Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,22 @@
22

33
![](../Documentation/Images/MRTK_Logo_Rev.png)
44

5-
Recognizing there are multiple ways in which developers want to be able to get access to project through Unity, the Mixed Reality Toolkit has been engineered to be available through the following methods:
5+
The MRTK is available via the following methods. For feedback on these methods, or to request an additional distribution method, please [file an issue on Github](https://github.com/Microsoft/MixedRealityToolkit-Unity/issues/new/choose)
66

7-
## Unity Asset downloadable from the MRTK GitHub site
7+
## Unity asset downloadable from the MRTK GitHub site
88

9-
You can download the packaged [Unity Asset from here](https://github.com/Microsoft/MixedRealityToolkit-Unity/releases) for importing in to your project.
9+
You can download the packaged [Unity assets from here](https://github.com/Microsoft/MixedRealityToolkit-Unity/releases) for importing into your project.
1010

11-
## Unity NuGet delivery (*Coming soon*)
11+
There are two Unity packages available for each release:
1212

13-
Unity now has an asset plugin for getting access to Unity projects using the dependency delivery solution known as NuGet.
13+
### Foundation
14+
This package contains the MRTK itself and all of the code and materials needed to build Mixed Reality experiences.
1415

15-
Simply install the [Unity NuGet package](https://assetstore.unity.com/packages/tools/utilities/nuget-for-unity-104640) and search for the Mixed Reality Toolkit to download the project.
16-
17-
## Unity Package Manager (*Coming soon*)
18-
19-
As soon as it's available, the MRTK team will be working with Unity to publish the Mixed Reality Toolkit as a package through their Unity Package Manager.
20-
21-
## Unity Asset Store (*under discussion*)
22-
23-
It has been raised within the Mixed Reality Toolkit team that the package should be published to the Unity store, this is currently being investigated.
24-
25-
Feedback is welcome through the [Mixed Reality GitHub site](https://github.com/Microsoft/MixedRealityToolkit-Unity/issues) (raise an issue to offer an opinion) and the [HoloDevelopers Slack channel](https://holodevelopersslack.azurewebsites.net/) for the Mixed Reality Toolkit.
16+
### Examples
17+
This is an optional package which contains example scenes and samples. This package is dependent on the Foundation package.
2618

2719
## GitHub submodule (advanced users)
2820

2921
For those who would like to contribute to the MRTK or prefer to have the latest code in their project, there is another way to get access to the latest and greatest of the Mixed Reality Toolkit, be it the Release code or the in-progress development of the project.
3022

31-
[Stephen Hodgson has provided a full guide](https://www.rageagainstthepixel.com/expert-import-mrtk/) for how to use Git Submodules to download and synchronize the toolkit in to your project.
32-
Don't worry though, you still have control on how you update your project and can even "Go back" to a previous version of the toolkit at any time by simply checking out a specific commit or tag.
33-
34-
35-
36-
## Feedback welcome
37-
If you feel there are other options not listed above that would be beneficial to Unity developers, please let us know on the links above
23+
[Stephen Hodgson has provided a full guide](https://www.rageagainstthepixel.com/expert-import-mrtk/) for how to use Git Submodules to download and synchronize the toolkit in to your project.

Documentation/GettingStartedWithTheMRTK.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To get started with the Mixed Reality Toolkit you will need:
1818
1. Go to the [MRTK release page](https://github.com/Microsoft/MixedRealityToolkit-Unity/releases).
1919
2. Under Assets, download both `Microsoft.MixedRealityToolkit.Unity.Examples.unitypackage` and `Microsoft.MixedRealityToolkit.Unity.Foundation.unitypackage`
2020

21-
The Mixed Reality Toolkit is available via [multiple delivery mechanisms](DownloadingTheMRTK.md) and in the future will be available via the Unity package manager.
21+
For additional delivery mechanisms, please see [Downloading the MRTK](DownloadingTheMRTK.md).
2222

2323
## Import MRTK packages into your Unity project
2424
1. Create a new Unity project, or open an existing project. When creating a project, make sure to select "3D" as the template type. We used 2018.3.9f1 for this tutorial, though any Unity 2018.3.x release should work.

0 commit comments

Comments
 (0)