Skip to content

Commit 114c419

Browse files
authored
Merge pull request #3800 from robertos/patch-1
Fix typos and improve clarity on README.md
2 parents 0fa874f + 46d8c6b commit 114c419

File tree

1 file changed

+22
-35
lines changed

1 file changed

+22
-35
lines changed

README.md

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

3-
# What is MixedRealityToolkit
3+
# What is the Mixed Reality Toolkit
44

5-
MRTK is a Microsoft Driven open source project.
5+
MRTK is a Microsoft driven open source project.
66

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.
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.
88

9-
# What's MRTK-Unity good for
9+
# MRTK-Unity goals
1010

11-
* Provide basic features as an easy to use SDK to reduce the barrier-to-entry to get started.
12-
11+
* Provide basic features as an easy to use SDK and reduce barriers to get started.
1312
* Enable rapid prototyping by providing the basic building blocks for MR app development.
14-
15-
* Showcase best practices in MR with UI controls and interactions that matches the WMR and HoloLens Shell.
16-
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.
18-
13+
* Showcase best practices in MR with UI controls and interactions that matches the WMR and HoloLens shell.
14+
* Support a wide audience, allowing solutions to be built that will run on multiple VR / AR / XR platforms such as Windows Mixed Reality, Steam and Open VR.
1915
* 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.
2016

21-
22-
# Required Software
17+
# Required software
18+
2319
| [![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)|
2420
| :--- | :--- | :--- | :--- |
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 |
26-
21+
| To develop apps for Windows 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 |
2722

28-
# Supported Platform
23+
# Supported platforms
2924

3025
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
3126

3227
- Microsoft HoloLens
3328
- Microsoft HoloLens 2
34-
- Microsoft Immersive headsets (IHMD)
29+
- Microsoft Windows Mixed Reality immersive headsets (WMR)
3530
- OpenVR (HTC Vive / Oculus Rift)
3631

3732
# Feature areas
@@ -40,7 +35,7 @@ The Mixed Reality Toolkit V2 will includes many APIs to accelerate the developme
4035

4136
* Articulated Hands + Gestures (HoloLens 2)
4237

43-
* Eye Tracking (HoloLens2)
38+
* Eye Tracking (HoloLens 2)
4439

4540
* Voice Commanding
4641

@@ -59,29 +54,27 @@ The Mixed Reality Toolkit V2 will includes many APIs to accelerate the developme
5954
* Diagnostic Tool
6055

6156

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.
57+
# Getting started with MRTK
6558

6659
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:
6760

6861
* [Downloading the Mixed Reality Toolkit](/Documentation/DownloadingTheMRTK.md)
6962
* [Getting Started with the Mixed Reality Toolkit](/Documentation/GettingStartedWithTheMRTK.md)
7063
* [Mixed Reality Toolkit configuration guide](/Documentation/MixedRealityConfigurationGuide.md)
7164

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/).
65+
Find this document, other documentation articles and the MRTK API reference on our [MRTK Dev Portal on github.io](https://microsoft.github.io/MixedRealityToolkit-Unity/).
7366

74-
# Engage with the Community
67+
# Engage with the community
7568

7669
Join the conversation around MRTK on [Slack](https://holodevelopers.slack.com/).
7770

7871
Ask questions about using MRTK on [Stack Overflow](https://stackoverflow.com/questions/tagged/mrtk).
7972

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.
73+
Search for solutions or file new issues in [GitHub](https://github.com/Microsoft/MixedRealityToolkit-Unity/issues).
8174

82-
Deep dive into project plan and learn how you can contribute to MRTK in our [wiki](https://github.com/Microsoft/MixedRealityToolkit-Unity/wiki).
75+
Deep dive into future plans and learn how you can contribute to MRTK in our [wiki](https://github.com/Microsoft/MixedRealityToolkit-Unity/wiki).
8376

84-
Join our weekly community shiproom to hear directly from the feature team. (link to come soon)
77+
Join our weekly community shiproom to hear directly from the feature team. (link coming soon)
8578

8679
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/).
8780

@@ -92,14 +85,14 @@ One radical change to the Mixed Reality Toolkit vNext, will be the standards and
9285

9386
New examples will follow strict guidelines, such as:
9487

95-
* Each example must have a use and demonstrate a real world test case (no tests).
88+
* Each example must have utility and demonstrate a real world test case (no tests).
9689
* Each example will use a standardized template, so all examples have the same look and feel.
9790
* Each sample will be fully documented, detailing both the use case it is demonstrating and how to implement the features demonstrated.
9891

9992
> Check the "Work In Progress" section of the [Windows Mixed Reality - vNext SDK](MRTK-SDK.md) for a peek at the first new example.
10093
10194

102-
**External\How To** docs folder is meant to help everyone with migrating forward or any simple doubts they might have about the process.
95+
The **External\How To** docs folder contains guides on migrating between versions and process troubleshooting.
10396
Please feel free to grow all these sections. We can't wait to see your additions!
10497

10598
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
@@ -110,16 +103,10 @@ For more information see the [Code of Conduct FAQ](https://opensource.microsoft.
110103
| :--------------------- | :----------------- | :------------------ | :------------------------ |
111104
| 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. |
112105

113-
### Learn more about MRTK Project
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
117-
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-
119106
### Build Status
120107

121108
| Branch | Status |
122109
|---|---|
123110
| `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)|
124111

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).
112+
### For details on the different branches used in the Mixed Reality Toolkit repositories, check the [Branch Guide](https://github.com/Microsoft/MixedRealityToolkit-Unity/wiki/Branch-Guide).

0 commit comments

Comments
 (0)