Skip to content

Commit

Permalink
Merge pull request #3800 from robertos/patch-1
Browse files Browse the repository at this point in the history 
Fix typos and improve clarity on README.md
  • Loading branch information
@cre8ivepark
cre8ivepark authored Apr 4, 2019
2 parents 0fa874f + 46d8c6b commit 114c419
Showing 1 changed file with 22 additions and 35 deletions.
57 changes: 22 additions & 35 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,37 +1,32 @@
<img src="External/ReadMeImages/MRTK_Logo_Rev.png">

# What is MixedRealityToolkit
# What is the Mixed Reality Toolkit

MRTK is a Microsoft Driven open source project.
MRTK is a Microsoft driven open source project.

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

# What's MRTK-Unity good for
# MRTK-Unity goals

* Provide basic features as an easy to use SDK to reduce the barrier-to-entry to get started.

* Provide basic features as an easy to use SDK and reduce barriers to get started.
* Enable rapid prototyping by providing the basic building blocks for MR app development.

* Showcase best practices in MR with UI controls and interactions that matches the WMR and HoloLens Shell.

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

* Showcase best practices in MR with UI controls and interactions that matches the WMR and HoloLens shell.
* 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.
* 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.


# Required Software
# Required software

| [![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)|
| :--- | :--- | :--- | :--- |
| 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 |

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

# Supported Platform
# Supported platforms

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

- Microsoft HoloLens
- Microsoft HoloLens 2
- Microsoft Immersive headsets (IHMD)
- Microsoft Windows Mixed Reality immersive headsets (WMR)
- OpenVR (HTC Vive / Oculus Rift)

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

* Articulated Hands + Gestures (HoloLens 2)

* Eye Tracking (HoloLens2)
* Eye Tracking (HoloLens 2)

* Voice Commanding

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


# Getting Started with MRTK

You can find out how to use MRTK to develop for Windows Mixed Reality on the MS Developer Site.
# Getting started with MRTK

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:

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

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

# Engage with the Community
# Engage with the community

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

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

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

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

Join our weekly community shiproom to hear directly from the feature team. (link to come soon)
Join our weekly community shiproom to hear directly from the feature team. (link coming soon)

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

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

New examples will follow strict guidelines, such as:

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

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

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

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

### Learn more about MRTK Project
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.

### How to Contribute
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!

### Build Status

| Branch | Status |
|---|---|
| `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)|

### 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).
### 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 comments on commit 114c419

Please sign in to comment.