Skip to content

Commit 8cede04

Browse files
author
David Kline
authored
Merge pull request #3676 from Microsoft/Yoyozilla-patch-2
Update again
2 parents 9abf825 + 418cb93 commit 8cede04

File tree

1 file changed

+67
-42
lines changed

1 file changed

+67
-42
lines changed

‎README.md‎

Lines changed: 67 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,93 @@
11
<img src="External/ReadMeImages/MRTK_Logo_Rev.png">
22

3-
# What is MixedRealityToolkit v2
4-
The V1 Mixed Reality Toolkit is a collection of scripts and components intended to accelerate development of applications targeting Microsoft HoloLens and Windows Mixed Reality headsets.
3+
# What is MixedRealityToolkit
54

6-
### For details on the different branches used in the Mixed Reality Toolkit repositories, check this [Branch Guide here](https://github.com/Microsoft/MixedRealityToolkit-Unity/wiki/Branch-Guide).
5+
MRTK is a Microsoft Driven opensource project.
6+
7+
MRTK-Unity provides a set of foundational components and features to accelerate MR app development in Unity. Latest Release of MRTK (V2) supports HoloLens/HoloLens 2, WMR, and OpenVR platform. Start your project with MRTK, and
78

8-
This new version of the MixedRealityToolkit aims to further extend the capabilities of the toolkit and also introduce new features, including the capability to support more VR/AR/XR platforms beyond Microsoft's own Mixed Reality setup.
9+
# What's MRTK-Unity good for
10+
11+
* Provide basic features as an easy to use SDK to reduce the barrier-to-entry to get started.
912

10-
The v2 branch is taking all the best lessons learned from the original HoloToolkit and refactoring / restructuring it to:
13+
* Enable rapid prototyping by providing the basic building blocks for MR app development.
1114

12-
* Support a wider audience, allowing solutions to be built that will run on multiple VR / AR / XR platforms, starting with Windows Mixed Reality and OpenVR.
15+
* Showcase best practices in MR with UI controls and interactions that matches the WMR and HoloLens Shell.
1316

14-
* Provide an easier to use SDK, to enable rapid prototyping and ease adoption for new users (or users of previous frameworks)
17+
* Support a wide audience, allowing solutions to be built that will run on multiple VR / AR / XR platforms such as Mixed Reality, Steam/Open VR.
1518

1619
* Ensure an extensive framework for advanced integrators, with the ability to swap out core components with their own should they wish to, or simply extend the framework to add new capabilities.
1720

18-
> Learn more about [Windows Mixed Reality](https://www.microsoft.com/en-gb/windows/windows-mixed-reality) here.
1921

20-
> Learn more about the architecture behind [Windows Mixed Reality - V2](MRTK-vNext.md) here.
22+
# Required Software
23+
| [![Windows 10 Creators Update](External/ReadMeImages/MRTK170802_Short_17.png)](https://www.microsoft.com/software-download/windows10) [Windows 10 FCU](https://www.microsoft.com/software-download/windows10)| [![Unity](External/ReadMeImages/MRTK170802_Short_18.png)](https://unity3d.com/get-unity/download/archive) [Unity 3D](https://unity3d.com/get-unity/download/archive)| [![Visual Studio 2017](External/ReadMeImages/MRTK170802_Short_19.png)](http://dev.windows.com/downloads) [Visual Studio 2017](http://dev.windows.com/downloads)| [![Simulator (optional)](External/ReadMeImages/MRTK170802_Short_20.png)](https://go.microsoft.com/fwlink/?linkid=852626) [Simulator (optional)](https://go.microsoft.com/fwlink/?linkid=852626)|
24+
| :--- | :--- | :--- | :--- |
25+
| To develop apps for mixed reality 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 |
2126

22-
> Learn more about the approach behind the [Windows Mixed Reality - V2 SDK](MRTK-SDK.md) here.
2327

24-
# Getting Started with MRTK
28+
# Supported Platform
2529

26-
You can find out how to use MRTK to develop for Windows Mixed Reality on the MS Developer Site.
30+
The Mixed Reality Toolkit V2 will includes many APIs to accelerate the development of MR / XR / VR / AR projects for a range of supported devices, starting with
2731

28-
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/).
32+
- Microsoft HoloLens
33+
- Microsoft HoloLens 2
34+
- Microsoft Immersive headsets (IHMD)
35+
- OpenVR (HTC Vive / Oculus Rift)
36+
37+
# Feature areas
2938

39+
* Input System
3040

31-
# Engage with the Community
41+
* Articulated Hands + Gestures (HoloLens 2)
3242

33-
Join us on [Slack](https://holodevelopers.slack.com/) where our developers are actively are actively answering questions and sharing out the latest thinking from the dev team.
43+
* Eye Tracking (HoloLens2)
3444

35-
[Stack Overflow](https://stackoverflow.com/questions/tagged/mrtk) is a great place to ask for how-to using MRTK or troubleshooting an issue. Use the tag "mrtk" for it show up in the developer team's sights.
45+
* Voice Commanding
3646

37-
For issues related to Windows Mixed Reality that aren't directly related to the MRTK, check out the [Windows Mixed Reality Developer Forum](https://forums.hololens.com/).
47+
* Gaze + Select (HoloLens)
3848

39-
Deep dive into project plan and learn how you can contribute to MRTK in our [wiki](https://github.com/Microsoft/MixedRealityToolkit-Unity/wiki).
49+
* Controller Visualization
4050

41-
# Build Status
51+
* Teleportation
4252

43-
| Branch | Status |
44-
|---|---|
45-
| `mrtk_development` |[![Build status](https://dev.azure.com/aipmr/MixedRealityToolkit-Unity-CI/_apis/build/status/public/mrtk_development-CI)](https://dev.azure.com/aipmr/MixedRealityToolkit-Unity-CI/_build/latest?definitionId=1)|
53+
* UI Controls
4654

47-
# Feature areas
48-
The Mixed Reality Toolkit vNext will includes many APIs to accelerate the development of MR / XR / VR / AR projects for a range of supported devices, starting with
55+
* Solver and Interactions
4956

50-
- Microsoft HoloLens
51-
- Microsoft Immersive headsets (IHMD)
52-
- OpenVR (HTC Vive / Oculus Rift)
53-
54-
# Required Software
55-
| [![Windows 10 Creators Update](External/ReadMeImages/MRTK170802_Short_17.png)](https://www.microsoft.com/software-download/windows10) [Windows 10 FCU](https://www.microsoft.com/software-download/windows10)| [![Unity](External/ReadMeImages/MRTK170802_Short_18.png)](https://unity3d.com/get-unity/download/archive) [Unity 3D](https://unity3d.com/get-unity/download/archive)| [![Visual Studio 2017](External/ReadMeImages/MRTK170802_Short_19.png)](http://dev.windows.com/downloads) [Visual Studio 2017](http://dev.windows.com/downloads)| [![Simulator (optional)](External/ReadMeImages/MRTK170802_Short_20.png)](https://go.microsoft.com/fwlink/?linkid=852626) [Simulator (optional)](https://go.microsoft.com/fwlink/?linkid=852626)|
56-
| :--- | :--- | :--- | :--- |
57-
| To develop apps for mixed reality 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 |
57+
* Spatial Understanding
58+
59+
* Diagnostic Tool
5860

59-
# Getting started with MRTK-vNext
60-
MRTK-vNext is currently under heavy development. To determine the best branch for starting out, please view the [Branch Guide](https://github.com/Microsoft/MixedRealityToolkit-Unity/wiki/Branch-Guide) wiki page.
61+
62+
# Getting Started with MRTK
63+
64+
You can find out how to use MRTK to develop for Windows Mixed Reality on the MS Developer Site.
6165

6266
The Mixed Reality team have prepared a few guides for getting up to speed on using the new Mixed Reality Toolkit, which can be found here:
6367

64-
* [Downloading the Mixed Reality Toolkit](Documentation/DownloadingTheMRTK.md)
65-
* [Getting Started with the Mixed Reality Toolkit](Documentation/GettingStartedWithTheMRTK.md)
66-
* [Mixed Reality Toolkit configuration guide](Documentation/MixedRealityConfigurationGuide.md)
68+
* [Downloading the Mixed Reality Toolkit](/Documentation/DownloadingTheMRTK.md)
69+
* [Getting Started with the Mixed Reality Toolkit](/Documentation/GettingStartedWithTheMRTK.md)
70+
* [Mixed Reality Toolkit configuration guide](/Documentation/MixedRealityConfigurationGuide.md)
71+
72+
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/).
73+
74+
# Engage with the Community
75+
76+
Join the conversation around MRTK on [Slack](https://holodevelopers.slack.com/).
6777

68-
More guides to follow.
78+
Ask questions about using MRRTK on [Stack Overflow](https://stackoverflow.com/questions/tagged/mrtk).
6979

80+
Search for solution or file a new issue in [GitHub](https://github.com/Microsoft/MixedRealityToolkit-Unity/issues) if you find something broken in MRTK code.
7081

71-
> Any queries, questions or feedback on using the Mixed Reality Toolkit should be [raised as Issues](https://github.com/Microsoft/MixedRealityToolkit-Unity/issues) on the site. let us know what you like / dislike or think is incredibly awesome!
72-
>
73-
> Alternatively, reach out to us on the [HoloDevelopers slack channels](https://holodevelopersslack.azurewebsites.net/)
82+
Deep dive into project plan and learn how you can contribute to MRTK in our [wiki](https://github.com/Microsoft/MixedRealityToolkit-Unity/wiki).
83+
84+
Join our weekly community shiproom to hear directly from the feature team. (link to come soon)
85+
86+
For issues related to Windows Mixed Reality that aren't directly related to the MRTK, check out the [Windows Mixed Reality Developer Forum](https://forums.hololens.com/).
7487

7588

7689
# Examples and QuickStart scenes
90+
7791
One radical change to the Mixed Reality Toolkit vNext, will be the standards and approaches to real world example scenes.
7892

7993
New examples will follow strict guidelines, such as:
@@ -96,5 +110,16 @@ For more information see the [Code of Conduct FAQ](https://opensource.microsoft.
96110
| :--------------------- | :----------------- | :------------------ | :------------------------ |
97111
| See code examples. Do a coding tutorial. Watch guest lectures. | Get design guides. Build user interface. Learn interactions and input. | Get development guides. Learn the technology. Understand the science. | Join open source projects. Ask questions on forums. Attend events and meetups. |
98112

99-
# How to Contribute
113+
### Learn more about MRTK Progect
114+
You can find our planning material on [our wiki](https://github.com/Microsoft/MixedRealityToolkit-Unity/wiki) under Project Management Section. You can always see the items the team is actively working on in the Iteration Plan issue.
115+
116+
### How to Contribute
100117
View the [**How To Contribute**](https://github.com/Microsoft/MixedRealityToolkit-Unity/wiki/How-to-Contribute) wiki page for the most up to date instructions on contributing to the Mixed Reality Toolkit!
118+
119+
### Build Status
120+
121+
| Branch | Status |
122+
|---|---|
123+
| `mrtk_development` |[![Build status](https://dev.azure.com/aipmr/MixedRealityToolkit-Unity-CI/_apis/build/status/public/mrtk_development-CI)](https://dev.azure.com/aipmr/MixedRealityToolkit-Unity-CI/_build/latest?definitionId=1)|
124+
125+
### For details on the different branches used in the Mixed Reality Toolkit repositories, check this [Branch Guide here](https://github.com/Microsoft/MixedRealityToolkit-Unity/wiki/Branch-Guide).

0 commit comments

Comments
 (0)