Skip to content

Commit

Permalink
Improvements to README
Browse files Browse the repository at this point in the history
  • Loading branch information
motionsmith authored Apr 11, 2017
1 parent 99bc9e3 commit a17458d
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,12 @@ You should now be able to code against the HoloLensCameraStream plugin after imp
The example Unity project can be found in the root `HoloLensVideoCaptureExample/` directory. This Unity project is a great way to learn how to use the CameraStream plugin in Unity, or to use as a template for your own Unity project. Read on to learn how to build and run the example project on your HoloLens. You should be familiar with creating and configuring a new Unity-HoloLens project [according to Microsoft's instructions](https://developer.microsoft.com/en-us/windows/mixed-reality/holograms_100). As Microsoft and Unity update their HoloLens documentation, I'm sure this tutorial will become out of date.
1. **Open the example project:** Navigate to and open the example project directory (`HoloLensVideoCaptureExample/`) in Unity.
2. **Configure build settings:** Once the project opens, select **File > Build Settings**. In the Platform list, select `Windows Store`. Set the SDK to `Universal 10`; set Target device to `HoloLens`; set UWP Build Type to `D3D`; check the Unity C# Projects checkbox; and finally, click **Switch Platform**.
3. **Build the project:** You can now build the Unity project, which generates a Visual Studio Solution (which you will then have to also build). In the Build window, click Build. In the explorer window that appears, make a new folder called `App`, which should live as a sibling next to the 'Assets` folder. Then click Select Folder to generate the VS solution in that folder. Then wait for Unity to build the solution.
4. **Open the VS Solution:** When the solution is build, a Windows explorer folder will open. Open the newly-built VS solution, which lives in 'App/HoloLensVideoCaptureExample.sln`. This is the solution that ultimately gets deployed to your HoloLens.
5. **Configure the deploy settings:** In the Visual Studio toolbar, change the solution platform from `ARM` to `x86`; Change the deploy target (the green play button) to `Device` (if your HoloLens is plugged into your computer), or 'Remote Machine' (if your HoloLens is connected via WiFi).
3. **Build the project:** You can now build the Unity project, which generates a Visual Studio Solution (which you will then have to also build). With the Build Settings window still open, click **Build**. In the explorer window that appears, make a new folder called `App`, which should live as a sibling next to the 'Assets` folder. Then click Select Folder to generate the VS solution in that folder. Then wait for Unity to build the solution.
4. **Open the VS Solution:** When the solution is built, a Windows explorer folder will open. Open the newly-built VS solution, which lives in `App/HoloLensVideoCaptureExample.sln`. This is the solution that ultimately gets deployed to your HoloLens.
5. **Configure the deploy settings:** In the Visual Studio toolbar, change the solution platform from `ARM` to `x86`; Change the deploy target (the green play button) to `Device` (if your HoloLens is plugged into your computer), or `Remote Machine` (if your HoloLens is connected via WiFi).
6. **Run the app:** Go to **Debug > Start Debugging**. Once the app is deployed to the HoloLens, you should see some confirmation output in the Output window.

If you have questions, [check out the FAQ](https://github.com/VulcanTechnologies/HoloLensCameraStream/wiki/FAQ).

## Contributing
We would love for you to contribute to this project. Take a look at the TODO list in the Plugin's solution, or look at the Issues tab on GitHub to see how you can contribute. Thanks, enjoy!

0 comments on commit a17458d

Please sign in to comment.