Merge branch 'MRTK-Master' into MRTK-Dev-Local

Author: StephenHodgson

README.md

@@ -18,6 +18,8 @@ Learn more about [mixed reality](https://developer.microsoft.com/en-us/windows/m
 [unity-version-badge]:            https://img.shields.io/badge/current%20unity%20editor%20version-2017.2.0f3%20MRTP-green.svg
 [![Github Release][unity-version-badge]][unity-download]
 
+Looking to upgrade your projects to Windows Mixed Reality? [Follow the Upgrade Guide](/UpgradeGuide.md).
+
 # Feature areas
 | ![Input](External/ReadMeImages/MRTK170802_Short_03.png) [Input](Assets/HoloToolkit/Input/README.md)                                               | ![Sharing](External/ReadMeImages/MRTK170802_Short_04.png) [Sharing](Assets/HoloToolkit/Sharing/README.md)   | ![Spatial Mapping](External/ReadMeImages/MRTK170802_Short_05.png) [Spatial Mapping](Assets/HoloToolkit/SpatialMapping/README.md)| 
 | :------------------------------------------------------------------------------------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------ |
@@ -86,16 +88,16 @@ If you're looking for **Boundary** tools:
 | Target Unity release  | Release timeframe | Master release tag | Toolkit release features |
 | --------------------- | ----------------- | ------------------ | ------------------------ |
 | 2017.1.0              | Early Aug 2017    | v1.2017.1.0        | <ul><li>Updating to Unity's beta build.</li><li>3D Keyboard for text entry.</li></ul>|
-| 2017.2.0              | End Sep 2017      | v1.2017.2.0        | <ul><li>Updating master with Windows Mixed Reality support (xR namespace).</li><li>RI Dev_Unity_2017.2.0 into master.</li><li>Toolkit will work on both HoloLens and immersive headsets.</li><li>Windows Mixed Reality motion controller support.</li></ul>|
+| 2017.2.0              | End Oct 2017      | v1.2017.2.0        | <ul><li>Updating master with Windows Mixed Reality support (xR namespace).</li><li>RI Dev_Unity_2017.2.0 into master.</li><li>Toolkit will work on both HoloLens and immersive headsets.</li><li>Windows Mixed Reality motion controller support.</li></ul>|
 | 2017.3.0              | End Dec 2017      | v1.2017.3.0        | <ul><li>360 video player prefabs.</li><li>Scriptable foveated rendering prefabs.</li></ul>|
 ### Dev_Unity_2017.2.0 branch
 
 | Target Unity release  | Release timeframe | Branch release tag | Branch pre-release features | Status |
 | --------------------- | ----------------- | ------------------ | --------------------------- | --------------------------- |
 | MRTP9                 | End July 2017     | v1.Dev.MRTP9       | <ul><li>Windows Mixed Reality support for working on both HoloLens and immersive headsets.</li><li>Gamepad support.</li><li>Windows Mixed Reality motion controller support.</li></ul>| [Complete: v1.Dev.MRTP9](https://github.com/Microsoft/HoloToolkit-Unity/releases/tag/v1.Dev.MRTP9) |
 | MRTP13                | Early Aug 2017    | v1.Dev.MRTP13      | <ul><li>Updating to MRTP13.</li><li>Windows Mixed Reality motion controller rendering with glTF format read from WU driver.</li></ul>| [Complete: v1.Dev.MRTP13](https://github.com/Microsoft/HoloToolkit-Unity/releases/tag/v1.Dev.MRTP13) |
-| 2017.2.0              | Mid Aug 2017      | v1.Dev.2017.2.0    | <ul><li>Adapting to Unity's breaking changes of xR namespace and others.</li></ul>| In progress |
-| 2017.2.0              | End Sep 2017      | v1.Dev.2017.2.1    | <ul><li>Merge branch into master.</li></ul>| Not started. |
+| 2017.2.0              | Early Oct 2017      | v1.Dev.2017.2.0    | <ul><li>Adapting to Unity's breaking changes of xR namespace and others.</li></ul>| Complete |
+| 2017.2.0              | End Mid 2017      | v1.Dev.2017.2.1    | <ul><li>Merge branch into master.</li></ul>| In Progress |
 
 # Upcoming Breaking Changes
 

UpgradeGuide.md

@@ -0,0 +1,36 @@
+# General Release Guidelines
+
+When updating the Mixed Reality Toolkit for Unity in your project always be sure to completely remove all the folders and assets of the toolkit before importing the unity package.  Unity does not handle assets that have been deleted, removed, or renamed.
+
+General releases will list breaking changes in their descriptions.
+
+## 2017.2 Upgrade Guide for Window Mixed Reality
+
+### What you'll need
+
+- [Unity Editor 2017.2.0f3 MRTP](http://beta.unity3d.com/download/edcd66fb22ae/download.html) or later
+- Running the Windows Fall Creator's Update Build 1709 or later
+- Visual Studio 2017 build 15.3 or later
+- Window 10 SDK 10.0.16267.0 or later
+
+### List of breaking changes
+- None to date.  See [Unity's upgrade guide](https://docs.unity3d.com/Manual/UpgradeGuide20172.html) for Unity Specific changes.
+
+## 2017.1 Upgrade Guide
+
+### What you'll need
+
+- [Unity Editor 2017.1.2f1](https://unity3d.com/unity/whats-new/unity-2017.1.2) or later
+- Window Build 1603 or later
+- Visual Studio 2015 or later
+- Windows 10 SDKs 10.0.10240.0 though 10.0.15063.0
+
+### List of breaking changes
+- `TryGetPosition` is now `TryGetPointerPosition`
+- `TryGetOrientation` is now `TryGetPointerRotation`
+- All other changes should throw `Obsolete` warnings with suggested updates.
+- Renamed feature folders
+- Merged Test and Example folders
+- Removed `MicStream` scripts and libraries until they pass WACK
+- `GameObjects` that utilize the `WorldAnchorStore` need to have unique names.
+- `SetGlobalListeners` now registers/unregisters during OnEnable/OnDisable.