Skip to content

Commit 304e401

Browse files
authored
Merge pull request #7266 from keveleigh/update-docs
Update docs for MSB4U resolution troubleshooting and add additional notes
2 parents 6092502 + 0fa877d commit 304e401

File tree

3 files changed

+5
-2
lines changed

3 files changed

+5
-2
lines changed

Documentation/README_ExampleHub.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ MRTK Examples Hub is a Unity scene that makes it easy to experience multiple sce
88

99
## Prerequisite
1010

11-
MRTK Examples Hub uses [Scene Transition Service](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/Extensions/SceneTransitionService/SceneTransitionServiceOverview.html) and related scripts. If you are using MRTK through Unity packages, please import **Microsoft.MixedReality.Toolkit.Unity.Extensions.x.x.x.unitypackage** which is part of the [release packages](https://github.com/microsoft/MixedRealityToolkit-Unity/releases). If you are using MRTK through the repository clone, you should already have **MixedRealityToolkit.Extensions** folder in your project.
11+
MRTK Examples Hub uses [Scene Transition Service](Extensions/SceneTransitionService/SceneTransitionServiceOverview.md) and related scripts. If you are using MRTK through Unity packages, please import **Microsoft.MixedReality.Toolkit.Unity.Extensions.x.x.x.unitypackage** which is part of the [release packages](https://github.com/microsoft/MixedRealityToolkit-Unity/releases). If you are using MRTK through the repository clone, you should already have **MixedRealityToolkit.Extensions** folder in your project.
1212

1313
## MRTKExamplesHub scene and the scene system
1414

Documentation/ReleaseNotes.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,12 +108,15 @@ After MSBuild for Unity is enabled, a Dependencies folder will be created in the
108108

109109
This folder is created by MSBuild for Unity and will be recreated when packages are restored. When using source control, such as GitHub, it can be safely added to exclude / ignore lists (ex: .gitignore).
110110

111+
You can also add the .bin and .obj folders in MixedRealityToolkit.Providers / WindowsMixedReality / Shared / DotNetAdapter to your ignore list. These represent staging folders for individual csproj package resolution but are hidden from Unity's Asset view. The root Dependencies folder is the central location where the used copies are placed.
112+
111113
**<project>.Dependencies.msb4u**
112114

113115
MSBuild for Unity creates two files in the project's Assets folder; NuGet.config and <project>.Dependencies.msb4u.csproj. These files are used by MSBuild for Unity and will be recreated as needed.
114116

115117
When using source control, such as GitHub, these files can be safely added to exclude / ignore lists (ex: .gitignore).
116118

119+
After MRTK has enabled MSBuild for Unity, additional custom NuGet dependencies can be declared and resolved as well. This process is described in [MSBuild for Unity's documentation](https://github.com/microsoft/MSBuildForUnity/blob/master/Documentation/CoreScenarios.md#scenario-1-adding-nuget-dependency-to-unity-project).
117120

118121
**Hand physics extension service**
119122

Documentation/Tools/HolographicRemoting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ For the first point, the best way to check is to open Window -> Package Manager
3535

3636
#### DotNetWinRT NuGet package resolution
3737

38-
For the second point, the best way to check is to search the Assets folder for DotNetWinRT.dll. If this doesn't exist, navigate to MixedRealityToolkit.Providers / WindowsMixedReality / Shared / DotNetAdapter in the Project view and select DotNetAdapter.csproj. Assuming part 1 did succeed, there should be a custom inspector with Build, Rebuild, and Clean buttons. Try clicking Build or Rebuild, and then re-search for DotNetWinRT.dll. If that DLL now exists, this step succeeded.
38+
For the second point, the best way to check is to search the Assets folder for DotNetWinRT.dll. If this doesn't exist, navigate to the Assets folder in the Project view and select `[ProjectName].Dependencies.msb4u.csproj`. Assuming part 1 did succeed, there should be a custom inspector with Build, Rebuild, and Clean buttons. Try clicking Build or Rebuild, and then re-search for DotNetWinRT.dll. If that DLL now exists, this step succeeded.
3939

4040
![DotNetAdapter Inspector](../Images/Tools/Remoting/DotNetAdapterInspector.png)
4141

0 commit comments

Comments
 (0)