manually updated and built docs (#745)

LICENSE.md

@@ -1,7 +1,7 @@
 MIT License
 
 Copyright (c) 2019 Microsoft Corporation
-Copyright (c) 2020 XRTK
+Copyright (c) 2021 XRTK
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,18 +1,24 @@
 # Welcome to the Mixed Reality Toolkit
 
-![](/images/Branding/XRTK_Logo_1200x250.png)
+![The Mixed Reality Toolkit](images/Branding/XRTK_Logo_1200x250.png)
 
 The Mixed Reality Toolkit's primary focus is to make it extremely easy to get started creating Mixed Reality applications and to accelerate deployment to multiple platforms from the same Unity project.
 
 ## Build Status
 
-| Modules | Build Agent | OpenUpm |
+| Modules | Azure Pipelines | OpenUpm |
 |---|---|---|
-|XRTK-Core|[![Build status](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_apis/build/status/Mixed%20Reality%20Toolkit-CI)](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_build/latest?definitionId=2)|[![openupm](https://img.shields.io/npm/v/com.xrtk.core?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.xrtk.core/)|
-|[SDK](https://github.com/XRTK/SDK)|[![Build status](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_apis/build/status/XRTK.SDK%20Master%20Build)](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_build/latest?definitionId=23)|[![openupm](https://img.shields.io/npm/v/com.xrtk.sdk?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.xrtk.sdk/)|
-|[WMR](https://github.com/XRTK/WindowsMixedReality)|[![Build status](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_apis/build/status/XRTK.WMR%20Master%20Build)](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_build/latest?definitionId=21)|[![openupm](https://img.shields.io/npm/v/com.xrtk.wmr?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.xrtk.wmr/)|
-|[Lumin](https://github.com/XRTK/Lumin)|[![Build status](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_apis/build/status/XRTK.Lumin%20Master%20Build)](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_build/latest?definitionId=29)|[![openupm](https://img.shields.io/npm/v/com.xrtk.lumin?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.xrtk.lumin/)|
-|[Oculus](https://github.com/XRTK/Oculus)|[![Build status](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_apis/build/status/XRTK.Oculus%20Master%20Build)](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_build/latest?definitionId=30)|[![openupm](https://img.shields.io/npm/v/com.xrtk.oculus?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.xrtk.oculus/)|
+|XRTK-Core|[![Build Status](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_apis/build/status/com.xrtk.core?branchName=master)](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_build/latest?definitionId=44&branchName=master)|[![openupm](https://img.shields.io/npm/v/com.xrtk.core?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.xrtk.core/)|
+|[SDK](https://github.com/XRTK/SDK)|[![Build Status](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_apis/build/status/com.xrtk.sdk?branchName=master)](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_build/latest?definitionId=50&branchName=master)|[![openupm](https://img.shields.io/npm/v/com.xrtk.sdk?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.xrtk.sdk/)|
+|[ARCore](https://github.com/XRTK/ARCore)|[![Build Status](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_apis/build/status/com.xrtk.arcore?branchName=master)](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_build/latest?definitionId=56&branchName=master)|[![openupm](https://img.shields.io/npm/v/com.xrtk.arcore?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.xrtk.arcore/)|
+|[Etee](https://github.com/XRTK/Etee)|[![Build Status](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_apis/build/status/com.xrtk.etee?branchName=master)](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_build/latest?definitionId=54&branchName=master)|[![openupm](https://img.shields.io/npm/v/com.xrtk.etee?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.xrtk.etee/)|
+|[Lenovo](https://github.com/XRTK/Lenovo)|[![Build Status](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_apis/build/status/com.xrtk.lenovo?branchName=master)](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_build/latest?definitionId=53&branchName=master)|[![openupm](https://img.shields.io/npm/v/com.xrtk.lenovo?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.xrtk.lenovo/)|
+|[Lumin](https://github.com/XRTK/Lumin)|[![Build Status](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_apis/build/status/com.xrtk.lumin?branchName=master)](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_build/latest?definitionId=47&branchName=master)|[![openupm](https://img.shields.io/npm/v/com.xrtk.lumin?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.xrtk.lumin/)|
+|[Nreal](https://github.com/XRTK/Nreal)|[![Build Status](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_apis/build/status/com.xrtk.nreal?branchName=master)](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_build/latest?definitionId=52&branchName=master)|[![openupm](https://img.shields.io/npm/v/com.xrtk.nreal?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.xrtk.nreal/)|
+|[Oculus](https://github.com/XRTK/Oculus)|[![Build Status](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_apis/build/status/com.xrtk.oculus?branchName=master)](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_build/latest?definitionId=48&branchName=master)|[![openupm](https://img.shields.io/npm/v/com.xrtk.oculus?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.xrtk.oculus/)|
+|[SteamVR](https://github.com/XRTK/SteamVR)|[![Build Status](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_apis/build/status/com.xrtk.steamvr?branchName=master)](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_build/latest?definitionId=55&branchName=master)|[![openupm](https://img.shields.io/npm/v/com.xrtk.steamvr?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.xrtk.steamvr/)|
+|[Ultraleap](https://github.com/XRTK/Ultraleap)|[![Build Status](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_apis/build/status/com.xrtk.ultraleap?branchName=master)](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_build/latest?definitionId=51&branchName=master)|[![openupm](https://img.shields.io/npm/v/com.xrtk.ultraleap?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.xrtk.ultraleap/)|
+|[Windows Mixed Reality](https://github.com/XRTK/WindowsMixedReality)|[![Build Status](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_apis/build/status/com.xrtk.wmr?branchName=master)](https://dev.azure.com/xrtk/Mixed%20Reality%20Toolkit/_build/latest?definitionId=49&branchName=master)|[![openupm](https://img.shields.io/npm/v/com.xrtk.wmr?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.xrtk.wmr/)|
 
 ## [Getting Started](articles/00-GettingStarted.md)
 
@@ -33,43 +39,44 @@ To improve this situation, the Mixed Reality Toolkit's vision is simple, to prov
 
 - **Advanced** Extensible: The framework is easy to extend and modify to add additional custom services to meet specific criteria and needs.
 
-Our philosophy is to enable developers to focus on building content and structure and not have to worry about the underlying complexities for supporting multiple platforms in order to build it everywhere and on each device as required.  In Short, built it once and ship it everywhere with as little effort as possible.
+Our philosophy is to enable developers to focus on building content and structure and not have to worry about the underlying complexities for supporting multiple platforms in order to build it everywhere and on each device as required.  In short, built it once and ship it everywhere with as little effort as possible.
 
 We’d like to invite all the major hardware vendors to help guide their platform-specific implementations, from Microsoft’s Windows Mixed Reality and Magic Leap’s Lumin OS to Google’s ARCore and Apple’s ARKit.  Including any upcoming Mixed Reality capable devices that would like to be included for adoption.
 
 ## Chat with the community
 
 We recently moved our main conversations regarding Mixed Reality Toolkit over to Discord, which allows us to do a lot more (and the chat/streaming there is awesome), but we keep a Mixed Reality Toolkit presence on Slack too, in order to retain links to our friends on there.
 
-[![Discord](https://cdn0.iconfinder.com/data/icons/free-social-media-set/24/discord-128.png)](https://t.co/UeUSVjnoIZ?amp=1)
+[![Discord](https://cdn0.iconfinder.com/data/icons/free-social-media-set/24/discord-128.png)](https://discord.gg/rJMSc8Z)
 
-### [Come join us on Discord!](https://t.co/UeUSVjnoIZ?amp=1)
+### [Come join us on Discord!](https://discord.gg/rJMSc8Z)
+
+## Sponsors
+
+The XRTK is an MIT-licensed open source project with its ongoing development made possible entirely by the support of these awesome sponsors and backers.
+
+|Sponsors||
+|---|---|
+|<a href="https://www.vimaec.com/">![[VIM](https://www.vimaec.com/)](/images/Sponsors/vim_logo.jpg)</a>|VIM provides a universal format for fast BIM access for large and complex projects in the AEC industry.|
+
+We use the donations for continuous active development by core team members, web hosting, and licensing costs for build tools and infrastructure.
 
 ## Supported Platforms
 
-By default, we support OpenVR on all platforms that support the standard, as well as Native SDK implementations for various vendors.
-
-- [x] Windows Standalone
-- [x] Linux
-- [x] OSX Standalone
-- [x] Open VR
-- [ ] Open XR
-- [x] [Windows Mixed Reality](https://github.com/XRTK/WindowsMixedReality)
-    - [x] HoloLens
-    - [x] Windows Mixed Reality HMDs
-    - [-] HoloLens 2 (platform supported, hands / eyes pending)
-- [x] [Lumin (aka Magic Leap)](https://github.com/XRTK/Lumin)
-- [x] [Native Oculus API](https://github.com/XRTK/Oculus)
-    - [x] Rift
-    - [x] Quest
-    - [ ] Go
-- [ ] Native Steam VR
-    - [ ] HTC Vive
-    - [ ] Vive Index
-- [ ] iOS
-    - [ ] ARKit
-- [ ] Android
-    - [ ] ARCore
-- [ ] WebAssembly
-    - [ ] WebVR
-    - [ ] WebXR
+A major component of the Mixed Reality Toolkit is the Platform definitions that was employed to both accurately determine what platforms have been added to the scope of the project and also to determine when a platform is active/running.
+
+## Current Platforms
+
+* OpenVR - Default runtime platform for Windows Standalone, no special consideration.
+* [Oculus](oculus.md)
+* [Windows Mixed Reality (UWP)](windowsmixedreality.md)
+* [Magic Leap (Lumin)](magicleap.md)
+
+## In development
+
+* [SteamVR](steamvr.md)
+* [etee](etee.md)
+* [Ultraleap](ultraleap.md)
+* [WebXR](webxr.md)
+
+> Want to add a platform? Check out our new [Template Generator](articles/03-template-generator.md#platform-template-generation)!