Skip to content

Commit 79ab010

Browse files
author
David Kline
authored
Merge pull request #6248 from davidkline-ms/upd210RelNotes
2.1.0 - Add nuget package information to release notes
2 parents 6407618 + 00008b4 commit 79ab010

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

Documentation/ReleaseNotes.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,16 @@ The following software is required.
2323
- Windows 10 SDK 18362 or later (installed by the Visual Studio Installer)
2424
- Unity 2018.4, 2019.1 or 2019.2
2525

26+
NuGet requirements
27+
28+
If importing the Mixed Reality Toolkit's NuGet packages, the following software is recommended.
29+
30+
- [NuGet for Unity](https://github.com/GlitchEnzo/NuGetForUnity)
31+
2632
### Upgrading projects to 2.1.0
2733

34+
**Updating using .unitypackage files**
35+
2836
The 2.1.0 release has some changes that may impact application projects, including some files moving to new folder locations.
2937
Breaking change details, including mitigation guidance, can be found in the [**Updating 2.0.0 to 2.1.0**](Updating.md#updating-200-to-210) article.
3038

@@ -62,8 +70,44 @@ For the smoothest upgrade path, please use the following steps.
6270

6371
Related to [issue #6144](https://github.com/microsoft/MixedRealityToolkit-Unity/issues/6144): after upgrading, if you have a custom input simulation profile, the input playback service data provider may have a missing class. Click the "Try Repair" button in the profile window to fix the missing reference.
6472

73+
**Updating from NuGet**
74+
75+
If your project was created using the Mixed Reality Toolkit NuGet packages, please use the following steps.
76+
77+
1. Select **NuGet > Manage NuGet Packages**
78+
1. Select the **Online** tab and click **Refresh**
79+
1. Select the **Installed** tab
80+
1. Click the **Update** button for each installed package
81+
- Microsoft.MixedReality.Toolkit.Foundation
82+
- Microsoft.MixedReality.Toolkit.Tools
83+
- Microsoft.MixedReality.Toolkit.Extensions
84+
- Microsoft.MixedReality.Toolkit.Examples
85+
1. Re-open the project in Unity
86+
87+
After updating the packages, you may see messages similar to the following:
88+
89+
```
90+
Failed to unload 'Assets/Packages/Microsoft.MixedReality.Toolkit.Examples.2.1.0/MRTK/StandardAssets/Models/Materials/Material_56.mat'
91+
```
92+
93+
The step to re-open the project in Unity resolves the issue.
94+
6595
### What's new in 2.1.0
6696

97+
**NuGet package distribution**
98+
99+
MRTK 2.1.0 now ships packages on nuget.org. The following steps can be used to import the desired packages.
100+
101+
1. Install [NuGet for Unity](https://github.com/GlitchEnzo/NuGetForUnity/releases)
102+
1. Select **NuGet > Manage NuGet Packages**
103+
1. In the search field, enter "MixedReality.Toolkit"
104+
1. Click **Search**
105+
1. Click **Install** for each desired package
106+
- Microsoft.MixedReality.Toolkit.Foundation
107+
- (Optional) Microsoft.MixedReality.Toolkit.Tools
108+
- (Optional) Microsoft.MixedReality.Toolkit.Extensions
109+
- (Optional) Microsoft.MixedReality.Toolkit.Examples
110+
67111
**Dwell interaction (Experimental)**
68112

69113
MRTK has added experimental support for dwell interactions. Dwell interactions enable applications to respond to a user focusing their gaze or motion controller on an interactable object for a predefined period of time.

0 commit comments

Comments
 (0)