Skip to content

Commit 5d7390c

Browse files
authored
Merge pull request #6965 from ms738/patch-29
Update GettingStartedWithTheMRTK.md
2 parents 77538b6 + 2352f8b commit 5d7390c

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

Documentation/GettingStartedWithTheMRTK.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The Mixed Reality Toolkit (MRTK) is a cross-platform toolkit for building Mixed
66

77
## Prerequisites
88

9-
To get started with the Mixed Reality Toolkit you will need:
9+
To get started with the Mixed Reality Toolkit, you will need:
1010

1111
* [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/)
1212
* [Unity 2018.4.x, 2019.1.x or 2019.2.x](https://unity3d.com/get-unity/download/archive)
@@ -36,28 +36,28 @@ To get started with the Mixed Reality Toolkit you will need:
3636
### Get the latest MRTK Unity packages
3737

3838
1. Go to the <a href="https://github.com/Microsoft/MixedRealityToolkit-Unity/releases" target="_blank">MRTK release page</a>.
39-
1. Under Assets, download
39+
1. Under Assets, download:
4040
* **Microsoft.MixedRealityToolkit.Unity.Foundation.unitypackage**
4141
* (**_Optional_**) Microsoft.MixedRealityToolkit.Unity.Extensions.unitypackage
4242
* (**_Optional_**) Microsoft.MixedRealityToolkit.Unity.Tools.unitypackage
4343
* (**_Optional_**) Microsoft.MixedRealityToolkit.Unity.Examples.unitypackage
4444
* (**_Optional_**, **_Experimental_**) Microsoft.MixedRealityToolkit.Unity.Providers.UnityAR.unitypackage
4545

46-
For information on package contents, please see [MRTK Package Contents](MRTK_PackageContents.md).
46+
For information on package contents, see [MRTK Package Contents](MRTK_PackageContents.md).
4747

48-
The Mixed Reality Toolkit is also available for download on NuGet.org, for details see [MRTK NuGet Packages](MRTKNuGetPackage.md).
48+
The Mixed Reality Toolkit is also available for download on NuGet.org; for details see [MRTK NuGet Packages](MRTKNuGetPackage.md).
4949

5050
### Import MRTK packages into your Unity project
5151

5252
1. Create a new Unity project, or open an existing project. When creating a project, make sure to select "3D" as the template type.
53-
1. Import the **Microsoft.MixedRealityToolkit.Unity.Foundation.unitypackage** you downloaded by going into "Asset -> Import Package -> Custom Package", selecting the .unitypackage file, ensure all items to import are checked, and then selecting "Import".
53+
1. Import the **Microsoft.MixedRealityToolkit.Unity.Foundation.unitypackage** you downloaded by going into "Asset -> Import Package -> Custom Package", select the .unitypackage file, ensure all items to import are checked, and then select "Import".
5454
1. (**_Optional_**) Import the **Microsoft.MixedRealityToolkit.Unity.Examples.unitypackage** following the same steps as above. The examples package is optional and contains useful demonstration scenes for current MRTK features.
55-
1. (**_Optional_**) Import the **Microsoft.MixedRealityToolkit.Unity.Tools.unitypackage** following the same steps as for the foundation package. These tools package is optional and contains useful tools, such as the ExtensionServiceCreator, that enhance the MRTK developer experience.
56-
1. (**_Optional_**) Import the **Microsoft.MixedRealityToolkit.Unity.Extensions.unitypackage** following the same steps as for the foundation package. The extensions package provides a set of useful optional components for the MRTK.
57-
1. (**_Optional_**) Import the **Microsoft.MixedRealityToolkit.Unity.Providers.UnityAR.unitypackage** following the same steps as for the foundation package. This package provides support for mobile AR (phone, tablet) devices in the MRTK.
55+
1. (**_Optional_**) Import the **Microsoft.MixedRealityToolkit.Unity.Tools.unitypackage** following the same steps as the foundation package. The tools package is optional and contains useful tools, such as the ExtensionServiceCreator, that enhance the MRTK developer experience.
56+
1. (**_Optional_**) Import the **Microsoft.MixedRealityToolkit.Unity.Extensions.unitypackage** following the same steps as the foundation package. The extensions package provides a set of useful optional components for the MRTK.
57+
1. (**_Optional_**) Import the **Microsoft.MixedRealityToolkit.Unity.Providers.UnityAR.unitypackage** following the same steps as the foundation package. This package provides support for mobile AR (phone, tablet) devices in the MRTK.
5858

5959
> [!Note]
60-
> Importing Microsoft.MixedRealityToolkit.Unity.Providers.UnityAR.unitypackage requires additional steps to be performed. For more information, please see the [UnityAR camera settings provider](CameraSystem/UnityArCameraSettings.md) article.
60+
> Importing Microsoft.MixedRealityToolkit.Unity.Providers.UnityAR.unitypackage requires additional steps to be performed. For more information, see the [UnityAR camera settings provider](CameraSystem/UnityArCameraSettings.md) article.
6161
6262
After importing the Foundation package, you may see a prompt similar to the following:
6363

@@ -70,17 +70,17 @@ MRTK is attempting to set up your project for building Mixed Reality solutions b
7070

7171
Accepting these options is completely optional, but recommended.
7272

73-
Some prefabs and assets require TextMesh Pro, meaning you have to have the TextMesh Pro package installed and the assets in your project (Window -> TextMeshPro -> Import TMP Essential Resources). **After you import TMP Essentials Resources, you need to restart Unity to see changes**.
73+
Some prefabs and assets require TextMesh Pro, meaning you need the TextMesh Pro package installed and the assets in your project (Window -> TextMeshPro -> Import TMP Essential Resources). **After you import TMP Essentials Resources, you need to restart Unity to see changes**.
7474

7575
### Switch your Unity project to the target platform
7676

7777
With the packages imported, the next step is to select the correct platform for the application.
7878

79-
To create a **HoloLens application**, switch to Universal Windows Platform:
79+
To create a **HoloLens application**, switch to the Universal Windows Platform:
8080

8181
1. Open menu : File > Build Settings
8282
1. Select **Universal Windows Platform** in the **Platform** list
83-
1. Click on the **Switch Platform** button
83+
1. Click the **Switch Platform** button
8484

8585
![Switch Platform](../Documentation/Images/getting_started/SwitchPlatform.png)
8686

@@ -117,7 +117,7 @@ To create a **HoloLens application**, switch to Universal Windows Platform:
117117
>[!NOTE]
118118
> While working in your scene, **DO NOT move the Main Camera** (or the **MixedRealityPlayspace**) from the scene origin (0,0,0). This is controlled by the MRTK and the active SDK. If you need to move the players start point, then **move the scene content and NOT the camera**!
119119
120-
1. Hit play and test out hand simulation by pressing the **spacebar**.
120+
1. Press Play and test out hand simulation by pressing the **spacebar**.
121121

122122
You are now ready to build and deploy to device! Follow the steps instructions at [Build and Deploy MRTK](BuildAndDeploy.md).
123123

@@ -143,11 +143,11 @@ To try the hand interaction scene, do the following steps.
143143

144144
![TMP Essentials](../Documentation/Images/getting_started/MRTK_GettingStarted_TMPro.png)
145145

146-
If you get such a prompt, select "Import TMP essentials" button. "TMP Essentials" refers to Text Mesh Pro plugin, which some of the MRTK examples use for improved text rendering. (See [Text in Unity](https://docs.microsoft.com/windows/mixed-reality/text-in-unity) for more detailed information)
146+
If you get such a prompt, select the "Import TMP essentials" button. "TMP Essentials" refers to Text Mesh Pro plugin, which some of the MRTK examples use for improved text rendering. (See [Text in Unity](https://docs.microsoft.com/windows/mixed-reality/text-in-unity) for more detailed information)
147147

148-
1. Close the TMP dialog. After this you need to reload the scene. You can do this by double clicking the scene in the project tab.
148+
1. Close the TMP dialog. After this you need to reload the scene. You can do this by double-clicking the scene in the Project tab.
149149

150-
1. Press the play button.
150+
1. Press the Play button.
151151

152152
## Using the in-editor hand input simulation to test a scene
153153

@@ -187,4 +187,4 @@ Here are some suggested next steps:
187187

188188
## Upgrading from the HoloToolkit (HTK/MRTK v1)
189189

190-
There is not a direct upgrade path from the HoloToolkit to Mixed Reality Toolkit v2 due to the rebuilt framework. However, it is possible to import the MRTK into your HoloToolkit project and migrate your implementation. For more information please see the [HoloToolkit to Mixed Reality Toolkit Porting Guide](HTKToMRTKPortingGuide.md)
190+
There is not a direct upgrade path from the HoloToolkit to Mixed Reality Toolkit v2 due to the rebuilt framework. However, it is possible to import the MRTK into your HoloToolkit project and migrate your implementation. For more information, see the [HoloToolkit to Mixed Reality Toolkit Porting Guide](HTKToMRTKPortingGuide.md)

0 commit comments

Comments
 (0)