Skip to content

Commit 1893146

Browse files
wiweiwiwei
authored
Merge pull request #3838 from cre8ivepark/mergedreadme-1
Merge README.md - removing duplicated sections
2 parents dce4c59 + 07578c7 commit 1893146

File tree

1 file changed

+42
-66
lines changed

1 file changed

+42
-66
lines changed

‎README.md‎

Lines changed: 42 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -5,61 +5,53 @@
55
MRTK is a Microsoft driven open source project.
66

77
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.
8-
9-
# MRTK-Unity goals
108

11-
* Provide basic features as an easy to use SDK and reduce barriers to get started.
12-
* Enable rapid prototyping by providing the basic building blocks for MR app development.
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.
15-
* 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.
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.
13+
* **Supports a wide range of platforms**, including
14+
* Microsoft HoloLens
15+
* Microsoft HoloLens 2
16+
* Microsoft Immersive headsets (IHMD)
17+
* Windows Mixed Reality headsets
18+
* OpenVR headsets (HTC Vive / Oculus Rift)
19+
20+
# Build Status
1621

17-
# Required software
18-
19-
| [![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)|
22+
| Branch | Status |
23+
|---|---|
24+
| `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)|
25+
26+
# Required Software
27+
| [![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)|
2028
| :--- | :--- | :--- | :--- |
2129
| 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 |
2230

23-
# Supported platforms
24-
25-
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
26-
27-
- Microsoft HoloLens
28-
- Microsoft HoloLens 2
29-
- Microsoft Windows Mixed Reality immersive headsets (WMR)
30-
- OpenVR (HTC Vive / Oculus Rift)
31-
32-
# Feature areas
33-
34-
* Input System
35-
36-
* Articulated Hands + Gestures (HoloLens 2)
37-
38-
* Eye Tracking (HoloLens 2)
39-
40-
* Voice Commanding
41-
42-
* Gaze + Select (HoloLens)
43-
44-
* Controller Visualization
31+
# Feature Areas
4532

46-
* Teleportation
47-
48-
* UI Controls
49-
50-
* Solver and Interactions
51-
52-
* Spatial Understanding
53-
54-
* Diagnostic Tool
33+
- Input System
34+
- Articulated Hands + Gestures (HoloLens 2)
35+
- Eye Tracking (HoloLens 2)
36+
- Voice Commanding
37+
- Gaze + Select (HoloLens)
38+
- Controller Visualization
39+
- Teleportation
40+
- UI Controls
41+
- Solver and Interactions
42+
- Spatial Understanding
43+
- Diagnostic Tool
5544

5645
# Getting Started with MRTK
5746
1. [Download MRTK](Documentation/DownloadingTheMRTK.md)
5847
2. Follow this [Getting Started Guide](Documentation/GettingStartedWithTheMRTK.md)
5948
3. Check out [Mixed Reality Toolkit configuration guide](Documentation/MixedRealityConfigurationGuide.md)
6049
4. Check out building blocks and example scenes(see the table below)
6150

62-
# Building blocks for UI and Interactions
51+
### More Documentation
52+
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/).
53+
54+
# UI and Interaction Building blocks
6355
| [![Button](External/ReadMeImages/Button/MRTK_Button_Main.png)](Documentation/README_Button.md) [Button](Documentation/README_Button.md) | [![Bounding Box](External/ReadMeImages/BoundingBox/MRTK_BoundingBox_Main.png)](Documentation/README_BoundingBox.md) [Bounding Box](Documentation/README_BoundingBox.md) | [![Manipulation Handler](External/ReadMeImages/ManipulationHandler/MRTK_Manipulation_Main.png)](Documentation/README_ManipulationHandler.md) [Manipulation Handler](Documentation/README_ManipulationHandler.md) |
6456
|:--- | :--- | :--- |
6557
| A button control which supports various input methods including HoloLens 2's articulated hand | Standard UI for manipulating objects in 3D space | Script for manipulating objects with one or two hands |
@@ -73,9 +65,9 @@ The Mixed Reality Toolkit V2 will includes many APIs to accelerate the developme
7365
# Example Scene
7466
You can find various types of interactions and UI controls in [this example scene](Documentation/README_HandInteractionExamples.md).
7567

76-
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/).
68+
[![Example Scene](External/ReadMeImages/MRTK_Examples.png)](Documentation/README_HandInteractionExamples.md)
7769

78-
# Engage with the community
70+
# Engage with the Community
7971

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

@@ -89,34 +81,18 @@ Join our weekly community shiproom to hear directly from the feature team. (link
8981

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

92-
# Examples and QuickStart scenes
93-
94-
One radical change to the Mixed Reality Toolkit vNext, will be the standards and approaches to real world example scenes.
95-
96-
New examples will follow strict guidelines, such as:
97-
98-
* Each example must have utility and demonstrate a real world test case (no tests).
99-
* Each example will use a standardized template, so all examples have the same look and feel.
100-
* Each sample will be fully documented, detailing both the use case it is demonstrating and how to implement the features demonstrated.
101-
102-
> Check the "Work In Progress" section of the [Windows Mixed Reality - vNext SDK](MRTK-SDK.md) for a peek at the first new example.
103-
104-
105-
The **External\How To** docs folder contains guides on migrating between versions and process troubleshooting.
106-
Please feel free to grow all these sections. We can't wait to see your additions!
107-
10884
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
10985
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
11086

111-
# Useful resources on Microsoft Windows Dev Center
87+
# Useful Resources on Microsoft Windows Dev Center
11288
| ![Academy](External/ReadMeImages/icon_academy.png) [Academy](https://developer.microsoft.com/en-us/windows/mixed-reality/academy)| ![Design](External/ReadMeImages/icon_design.png) [Design](https://developer.microsoft.com/en-us/windows/mixed-reality/design)| ![Development](External/ReadMeImages/icon_development.png) [Development](https://developer.microsoft.com/en-us/windows/mixed-reality/development)| ![Community)](External/ReadMeImages/icon_community.png) [Community](https://developer.microsoft.com/en-us/windows/mixed-reality/community)|
11389
| :--------------------- | :----------------- | :------------------ | :------------------------ |
11490
| 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. |
11591

116-
### Build Status
92+
### Learn more about MRTK Project
93+
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.
11794

118-
| Branch | Status |
119-
|---|---|
120-
| `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)|
95+
### How to Contribute
96+
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!
12197

122-
### 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).
98+
### 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)