You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-16Lines changed: 18 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,20 +2,21 @@
2
2
3
3
# What is the Mixed Reality Toolkit
4
4
5
-
MRTK is a Microsoft driven open source project.
6
-
7
-
MRTK-Unity provides a set of foundational components and features to accelerate MR app development in Unity. The latest Release of MRTK (V2) supports HoloLens/HoloLens 2, Windows Mixed Reality, and OpenVR platforms.
5
+
MRTK-Unity is a Microsoft driven project that provides a set of components and features to accelerate cross-platform MR app development in Unity. Here are some things MRTK does:
8
6
9
-
* Provides the **basic building blocks for unity development on HoloLens, Windows Mixed Reality, and OpenVR**.
10
-
* Showcases UX best practices with **UI controls that match Windows Mixed Reality and HoloLens Shell**.
11
-
***Enables rapid prototyping** via in-editor simulation that allows you to see changes immediately.
12
-
* Is **extensible**. Provides devs ability to swap out core components and extend the framework.
7
+
* Provides the **basic building blocks for Unity development on HoloLens, Windows Mixed Reality, and OpenVR**.
8
+
* Enables **rapid prototyping** via in-editor simulation that allows you to see changes immediately.
9
+
* Designed as an **extensible framework** that provides developers ability to swap out core components.
13
10
***Supports a wide range of platforms**, including
14
11
* Microsoft HoloLens
15
12
* Microsoft HoloLens 2
16
13
* Windows Mixed Reality headsets
17
14
* OpenVR headsets (HTC Vive / Oculus Rift)
18
15
16
+
# Getting Started with MRTK
17
+
|[](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/GettingStartedWithTheMRTK.html)<br/>[MRTK Getting Started Guide](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/GettingStartedWithTheMRTK.html)|[](https://microsoft.github.io/MixedRealityToolkit-Unity/)<br/>[MRTK Documentation](https://microsoft.github.io/MixedRealityToolkit-Unity/)|
18
+
|:---|:---|
19
+
19
20
# Build Status
20
21
21
22
| Branch | CI Status | Docs Status |
@@ -26,18 +27,14 @@ MRTK-Unity provides a set of foundational components and features to accelerate
26
27
27
28
|[](https://developer.microsoft.com/en-US/windows/downloads/windows-10-sdk)[Windows SDK 18362+](https://developer.microsoft.com/en-US/windows/downloads/windows-10-sdk)|[](https://unity3d.com/get-unity/download/archive)[Unity 2018.4.x](https://unity3d.com/get-unity/download/archive)|[](http://dev.windows.com/downloads)[Visual Studio 2017](http://dev.windows.com/downloads)|[](https://go.microsoft.com/fwlink/?linkid=852626)[Simulator (optional)](https://go.microsoft.com/fwlink/?linkid=852626)|
28
29
| :--- | :--- | :--- | :--- |
29
-
| To build apps with MRTK v2, you need the Windows 10 May 2019 Update SDK. <br> To run apps for Windows Mixed Reality immersive headsets, you need the Windows 10 Fall Creators Update. | The Unity 3D engine provides support for building mixed reality projects in Windows 10 | Visual Studio is used for code editing, deploying and building UWP app packages | The Emulators allow you test your app without the device in a simulated environment |
30
+
| To build apps with MRTK v2, you need the Windows 10 May 2019 Update SDK. <br> To run apps for immersive headsets, you need the Windows 10 Fall Creators Update. | The Unity 3D engine provides support for building mixed reality projects in Windows 10 | Visual Studio is used for code editing, deploying and building UWP app packages | The Emulators allow you test your app without the device in a simulated environment |
|[MRTK Standard Shader](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/README_MRTKStandardShader.html?q=shader)|[Speech](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/Input/Speech.html)<br/> & [Dictation](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/Input/Dictation.html)|[Boundary<br/>System](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/Boundary/BoundarySystemGettingStarted.html)|[In-Editor<br/>Simulation](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/InputSimulation/InputSimulationService.html)|[Experimental<br/>Features](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/ExperimentalFeatures.html)|
35
37
36
-
# Getting Started with MRTK
37
-
Please check out the [Getting Started Guide](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/GettingStartedWithTheMRTK.html)
38
-
39
-
### More Documentation
40
-
Find this readme, other documentation articles and the MRTK api reference on our [MRTK Dev Portal on github.io](https://microsoft.github.io/MixedRealityToolkit-Unity/).
[Periodic Table of the Elements](https://github.com/Microsoft/MRDL_Unity_PeriodicTable) is an open-source sample app which demonstrates how to use MRTK's input system and building blocks to create an app experience for HoloLens and Immersive headsets. Read the porting story: [Bringing the Periodic Table of the Elements app to HoloLens 2 with MRTK v2](https://medium.com/@dongyoonpark/bringing-the-periodic-table-of-the-elements-app-to-hololens-2-with-mrtk-v2-a6e3d8362158)
63
+
64
+
[](https://medium.com/@dongyoonpark/bringing-the-periodic-table-of-the-elements-app-to-hololens-2-with-mrtk-v2-a6e3d8362158)
65
+
64
66
# Engage with the Community
65
67
66
68
- Join the conversation around MRTK on [Slack](https://holodevelopers.slack.com/).
0 commit comments