Readme update suggestions

microsoft / MixedRealityToolkit

The MixedRealityToolkit is a collection of scripts and components intended to accelerate the development of mixed reality applications targeting Windows Mixed Reality.

MIT License

859 stars 275 forks source link

Readme update suggestions #28

Closed StephenHodgson closed 7 years ago

StephenHodgson commented 8 years ago

The readme file should include the prerequisite SDKs and other setup steps as well as the proper build order for each solution.

jwittner commented 8 years ago

Agreed!

SDKs currently needed:

Windows SDK 10.0.10240
Windows SDK 10.0.10586
Java SDK 8?

StephenHodgson commented 8 years ago

Is Java SDK 8 is needed in the current builds?

See I would have never known that! haha

jwittner commented 8 years ago

@HodgsonSDAS Not sure if 7 would work, but 8 does for me. Java was required when I tried to build the Sharing Solution under Visual Studio. I'm hoping people will start adding known requirements here and we can then go update the docs.

StephenHodgson commented 8 years ago

Actually doing some digging today and I found the docs. https://github.com/Microsoft/HoloToolkit/blob/master/Sharing/Src/Source/Docs/ExtendedDocs/GettingStarted.md They just seem to be buried deep in folders inside the project. I guess it would be simpler just to extend the Wiki or main ReadMe.md to include links to these.