Merged PR 592: Updated readme with latest features

Added new features introduced in 0.10 and did a bit of general cleanup.

Related work items: #582

Docs/WelcomeToUXTools.md

@@ -10,7 +10,7 @@ keywords: Unreal, Unreal Engine, UE4, HoloLens, HoloLens 2, Mixed Reality, devel
 
 # Welcome to UX Tools
 
-![Mixed Reality Toolkit](Images/MRTK_Unreal_UXT_Banner_Rounded.png)
+![Mixed Reality Toolkit](Images/Logos/MRTK_Unreal_UXT_Banner_Rounded.png)
 
 UX Tools is the first MRTK-Unreal component to be released and is currently only supported on HoloLens 2. The component plugin includes code, blueprints, and example assets of common UX features for input simulation, hand interaction actors, press-able button components, manipulator components and follow behavior components.
 

README.md

@@ -1,20 +1,20 @@
-![Mixed Reality Toolkit](Docs/Images/MRTK_Unreal_UXT_Banner_Rounded.png)
+![Mixed Reality Toolkit](Docs/Images/Logos/MRTK_Unreal_UXT_Banner_Rounded.png)
 
 # What are the UX Tools?
 
-UX Tools for Unreal Engine is a UE game plugin with code, blueprints and example assets created to help you add in features commonly needed when you're developing UX for mixed reality applications. The project is still in early development (it provides a small set of features and breaking changes are to be expected) but the current features are complete and robust enough to use in your own projects.  
+UX Tools for Unreal Engine is a UE game plugin with code, blueprints and example assets created to help you add in features commonly needed when you're developing UX for Mixed Reality applications.
 
-| NOTE: Only HoloLens 2 development is supported at the moment.  |
-| --- | 
+| NOTE: Only HoloLens 2 development is supported at the moment. |
+| --- |
 
 ![Features](Docs/Images/Features.png)
 
 # Getting started with UX Tools
 
 If you're new to MRTK or Mixed Reality development in Unreal, **we recommend starting at the beginning of our** [Unreal development journey](https://docs.microsoft.com/windows/mixed-reality/unreal-development-overview) in the Microsoft Docs. The Unreal development journey is specifically tailored to walk new developers through the installation, core concepts, and usage of the UX Tools.
 
- | CAUTION: The Unreal development journey currently uses **UX Tools 0.10.x** and **Unreal 4.25.3 or later**.  |
-| --- | 
+| CAUTION: The Unreal development journey currently uses **UX Tools 0.10.x** and **Unreal 4.25.3+**. |
+| --- |
 
 If you're already familiar with Mixed Reality development in Unreal, you can find the installation instructions for the UX Tools plugin [here](Docs/Installation.md).
 
@@ -25,21 +25,23 @@ If you're already familiar with Mixed Reality development in Unreal, you can fin
 
 # Required software
 
- | [![Utilities](Docs/Images/Windows-Logo.png)](https://developer.microsoft.com/windows/downloads/windows-10-sdk) [Windows SDK 18362+](https://developer.microsoft.com/windows/downloads/windows-10-sdk)| [![Unreal](Docs/Images/Unreal-Logo.png)](https://www.unrealengine.com/get-now) [Unreal 4.25.3 or later](https://www.unrealengine.com/get-now)| [![Visual Studio 2019](Docs/Images/VS-Logo.png)](http://dev.windows.com/downloads) [Visual Studio 2019](http://dev.windows.com/downloads)|
-| :--- | :--- | :--- | 
-| To build apps with MRTK-Unreal and UX Tools, you need the Windows 10 May 2019 Update SDK | The Unreal Engine provides support for building mixed reality projects in Windows 10 | Visual Studio is used for code editing |
+ | [![Utilities](Docs/Images/Windows-Logo.png)](https://developer.microsoft.com/windows/downloads/windows-10-sdk) <br> [Windows SDK 18362+](https://developer.microsoft.com/windows/downloads/windows-10-sdk)| [![Unreal](Docs/Images/Unreal-Logo.png)](https://www.unrealengine.com/get-now) <br> [Unreal 4.25.3+](https://www.unrealengine.com/get-now)| [![Visual Studio 2019](Docs/Images/VS-Logo.png)](http://dev.windows.com/downloads) <br> [Visual Studio 2019](http://dev.windows.com/downloads)|
+| :--- | :--- | :--- |
+| To build apps with MRTK-Unreal and UX Tools, you need the Windows 10 May 2019 Update SDK | The Unreal Engine provides support for building Mixed Reality projects in Windows 10 | Visual Studio is used for code editing |
 
 # UX building blocks
 
-| [![Input Simulation](Docs/Images/InputSimulation_Main.png)](Docs/InputSimulation.md) [Input Simulation](Docs/InputSimulation.md)| [![Hand Interaction](Docs/Images/PokeInteraction.png)](Docs/HandInteraction.md) [Hand Interaction](Docs/HandInteraction.md)| [![Pressable Button](Docs/Images/MRTK_Button_Main.png)](Docs/PressableButton.md) [Pressable Button](Docs/PressableButton.md)|
+| [![Input Simulation](Docs/Images/FeatureCards/InputSimulation.png)](Docs/InputSimulation.md) [Input Simulation](Docs/InputSimulation.md) | [![Hand Interaction](Docs/Images/FeatureCards/HandInteraction.png)](Docs/HandInteraction.md) [Hand Interaction](Docs/HandInteraction.md) | [![Button](Docs/Images/FeatureCards/PressableButton.png)](Docs/PressableButton.md) [Button](Docs/PressableButton.md) |
 |:--- | :--- | :--- |
-| Mouse and keyboard input in the editor to simulate a Head-Mounted Display and hand tracking | Hand interaction actor that takes care of creating and driving pointers and visuals for interactions | A button gives the user a way to trigger an immediate action |
-| [![Pinch Slider](Docs/Images/Pinch-Slider.png)](Docs/PinchSlider.md) [Pinch Slider](Docs/PinchSlider.md)| [![Bounds Control](Docs/Images/MRTK_BoundingBox_Main.png)](Docs/BoundsControl.md) [Bounds Control](Docs/BoundsControl.md)| [![Manipulators](Docs/Images/Hand-Interaction.png)](Docs/Manipulator.md) [Manipulators](Docs/Manipulator.md)|
-| A component allows the user to continuously change a value by moving the slider thumb along the track | A component that allows the user to change the position, rotation, and size of an actor | A component that allows an actor to be picked up by a user and then moved, rotated or scaled |
-| [![Follow Behavior](Docs/Images/FollowComponent.png)](Docs/FollowComponent.md) [Follow Behavior](Docs/FollowComponent.md)| [![Hand Constraints](Docs/Images/HandConstraint/HandContraintsBack.png)](Docs/HandConstraintComponent.md) [Hand Constraints](Docs/HandConstraintComponent.md)| [![Palm Constraints](Docs/Images/HandConstraint/HandContraintsFront.png)](Docs/PalmUpConstraintComponent.md) [Palm Constraints](Docs/PalmUpConstraintComponent.md)|
-| A component used to keep objects "following" the user by applying a set of constraints on the component's owner | A component that calculates a goal based on hand tracking and moves the owning actor | A hand constraint component specialization that activates only when the palm is facing the player |
-| [![Far Beam](Docs/Images/FarBeam.png)](Docs/FarBeam.md) [Far Beam](Docs/FarBeam.md) | 
-| A component allowing the user to visualize elements in the scene they can interact with from afar |
+| In-editor simulation of articulated hands and headset pose | Support for far and near hand interactions with Unreal's primitives | A 3d button specifically designed for hand interactions |
+| [![Slider](Docs/Images/FeatureCards/PinchSlider.png)](Docs/PinchSlider.md) [Slider](Docs/PinchSlider.md)| [![Bounds Control](Docs/Images/FeatureCards/BoundsControl.png)](Docs/BoundsControl.md) [Bounds Control](Docs/BoundsControl.md)| [![Manipulators](Docs/Images/FeatureCards/Manipulator.png)](Docs/Manipulator.md) [Manipulators](Docs/Manipulator.md)|
+| A 3d slider specifically designed for hand interactions | A component that allows the user to transform an actor via affordances | A component that allows an actor to be picked up by a user and then moved, rotated or scaled |
+| [![Hand Menu](Docs/Images/FeatureCards/HandMenu.png)](Docs/HandMenu.md) [Hand Menu](Docs/HandMenu.md) | [![Near Menu](Docs/Images/FeatureCards/NearMenu.png)](Docs/NearMenu.md) [Near Menu](Docs/NearMenu.md) | [![UMG support](Docs/Images/FeatureCards/UMG.png)](Docs/WidgetComponent.md) [UMG support](Docs/WidgetComponent.md) |
+| Hand-attached UI great for frequently used functions | Floating menu UI for near interactions | A component that allows hand-driven interactions with Unreal's UMG widgets |
+| [![Tap to Place](Docs/Images/FeatureCards/TapToPlace.png)](Docs/TapToPlaceComponent.md) [Tap to Place](Docs/TapToPlaceComponent.md) | [![Follow Behavior](Docs/Images/FeatureCards/FollowComponent.png)](Docs/FollowComponent.md) [Follow Behavior](Docs/FollowComponent.md) | [![Surface Magnetism](Docs/Images/FeatureCards/SurfaceMagnetism.png)](Docs/SurfaceMagnetism.md) [Surface Magnetism](Docs/SurfaceMagnetism.md) |
+| A component that can be used to easily place primitive components against surfaces | A component used to keep objects "following" the user by applying a set of constraints on the component's owner | A component that allows an actor to stick to a surface |
+| [![UI Element](Docs/Images/FeatureCards/UIElement.png)](Docs/UIElements.md) [UI Element](Docs/UIElements.md) |
+| A component that allows an actor's visibility to be controlled by its parent actor, allowing for easy construction of hierarchical UIs |
 
 # Tools
 
@@ -49,27 +51,27 @@ If you're already familiar with Mixed Reality development in Unreal, you can fin
 
 # Example maps
 
-If you want to explore the different UXT features or want a reference for how to use them we recommend having a look at the example maps contained in the _UX Tools Game_ (/UXToolsGame) in this repository. For that you should:
+If you want to explore the different UXT features or want a reference for how to use them, we recommend having a look at the example maps contained in the _UX Tools Game_ (/UXToolsGame) in this repository. For that you should:
 
 1. [Clone](https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop) this repository.
-1. [Checkout](https://help.github.com/en/desktop/contributing-to-projects/switching-between-branches) public/0.10.x.
-    * Bear in mind that this branch is alive. It's not a release, and will be **updated regularly with potentially breaking changes**. There will be a release tag (e.g. release/0.10.0) marked as such in GitHub.
+1. [Checkout](https://help.github.com/en/desktop/contributing-to-projects/switching-between-branches) the latest 'public/_version_.x' branch.
+    * Bear in mind that this branch is alive. It's not a release, and will be **updated regularly with potentially breaking changes**. There will be a release tag (e.g. _release/0.10.0_) marked as such in GitHub.
 
 You can now open the _UX Tools Game_ (/UXToolsGame) and explore individual example maps or open the _Loader_ level to access some of the examples from a centralized hub.
 
-# Packaged UX Tools game
+# Packaged UX Tools Game
 
-We also provide the UX Tools game pre-packaged for HoloLens 2 so you can try out the main UXT features directly on device easily. To use it:
+We also provide the _UX Tools Game_ pre-packaged for HoloLens 2 so you can try out the main UXT features directly on device easily. To use it:
 
 1. Obtain the packaged game from the latest release page (e.g. _UXTGame-HoloLens.0.10.0.zip_) and unzip it to a local directory.
-1. Install it in the device via the [Device Portal](https://docs.microsoft.com/en-us/windows/uwp/debug-test-perf/device-portal-hololens).
+1. Install it in the device via the [Device Portal](https://docs.microsoft.com/en-us/windows/uwp/debug-test-perf/device-portal#install-sideload-an-app).
 
 # Sample apps made with UX Tools
 
 | [![Chess App](Docs/Images/Samples_Chess.png)](https://docs.microsoft.com/en-us/windows/mixed-reality/develop/unreal/tutorials/unreal-uxt-ch1) | [![Kippy's Escape](Docs/Images/Samples_KE.jpg)](https://aka.ms/KippysEscape) |
 |:--- |:--- |
-| This simple [Chess App](https://github.com/microsoft/MixedReality-Unreal-Samples/tree/master/ChessApp) is the final result of following the getting started tutorial located on Microsoft's Mixed Reality docs. If you're new to mixed reality development and UX Tools, get started here: [Build a chess app with MRTK UX Tools](https://docs.microsoft.com/en-us/windows/mixed-reality/develop/unreal/tutorials/unreal-uxt-ch1) | [Kippy's Escape](https://github.com/microsoft/MixedReality-Unreal-KippysEscape) is an open-source HoloLens 2 sample app demonstrating how to use UX Tools components to create a fun and interactive mixed reality experience. Read the story behind the app: [The Making of Kippy's Escape](https://aka.ms/KippysEscape) |
+| This simple [Chess App](https://github.com/microsoft/MixedReality-Unreal-Samples/tree/master/ChessApp) is the final result of following the getting started tutorial located on Microsoft's Mixed Reality docs. If you're new to Mixed Reality development and UX Tools, get started here: [Build a chess app with MRTK UX Tools](https://docs.microsoft.com/en-us/windows/mixed-reality/develop/unreal/tutorials/unreal-uxt-ch1) | [Kippy's Escape](https://github.com/microsoft/MixedReality-Unreal-KippysEscape) is an open-source HoloLens 2 sample app demonstrating how to use UX Tools components to create a fun and interactive Mixed Reality experience. Read the story behind the app: [The Making of Kippy's Escape](https://aka.ms/KippysEscape) |
 
 # Feedback and contributions
 
-Due to the early stage of the project and the likelihood of internal refactors, we are not in a position to accept external contributions through pull requests at this time. However, contributions and feedback in the shape of bug reports, suggestions and feature requests are always welcome!
+Contributions and feedback in the shape of bug reports, suggestions and feature requests are always welcome! However, we are not in a position to accept external contributions through pull requests at this time.