MicrosoftDocs / mixed-reality

Mixed Reality documentation
Creative Commons Attribution 4.0 International
173 stars 184 forks source link

Build instructions for Unity are missing important steps #593

Open kevinfoley opened 2 years ago

kevinfoley commented 2 years ago

The Using Visual Studio to Deploy and Debug page describes deploying a project made with DirectX or Unity. The page describes configuring your environment, selecting compilation options, etc.

The page is missing the critical detail that, if you are using Unity, the project must first be built from the Unity Editor, as described at the Build and deploy to the HoloLens page. Building from the Unity Editor generates a new Visual Studio solution that can be used to build and deploy to the HoloLens.

Without this critical detail, developers may mistakenly think that they are supposed to configure the compilation options and build from the standard C# Visual Studio solution that is created with the Unity project and contains their C# source code, rather than the solution that is generated when building from the Unity Editor and contains the transpiled IL2CPP code. The C# Visual Studio solution does not have the same build configurations (e.g. Master) and CPU options (e.g. ARM64) as the IL2CPP solution.

There should be a sentence near the top of the Using Visual Studio to deploy and debug page explaining that Unity users must first follow the instructions at the Build and deploy to the HoloLens page. That page describes deploying over USB from Unity, but the user can just change the "Build and Run On" option to "Local Machine" if they are planning to deploy from Visual Studio.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.