Merge pull request #93 from KhronosGroup/SetupGuide

Add setup guide to README

README.md

@@ -223,7 +223,22 @@ Features
 - [ ] Handles anti-aliasing via WebGL MSAA
 - [x] Straightforward rendering of the scene graph
 - [ ] Selection of tonemapping algorithms for IBL
-- [ ] Support for the KHR_materials_unlit extension
-- [ ] Support for the KHR_texture_transform extension
+- [x] Support for the KHR_materials_unlit extension
+- [x] Support for the KHR_texture_transform extension
 - [ ] Support for the KHR_lights_punctual extension
 - [ ] Educational GUI for inspecting BRDF components
+
+Setup
+-----
+**General**
+* Checkout the [`reference-viewer`](../../tree/reference-viewer) branch
+* Pull the submodule if you want the example assets (`git submodule update  --init --recursive`)
+
+**Debugging**
+* Needed for this: [Visual Studio Code](https://code.visualstudio.com/) and [Mozilla Firefox](https://www.mozilla.org/en-US/firefox/new/) (you can also use [Chrome](https://www.google.com/chrome/), but the setup is more complicated)
+* Install the [Debugger for Firefox](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-firefox-debug) extension for VS Code (or [Debugger for Chrome](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome) if you insist)
+* Open the project folder in VS Code and select `Debug->Add Configuration->Firefox` so the `.vscode/launch.json` file is created
+* `Debug->Start Debugging` should now launch a Firefox window with the reference viewer and VS Code breakpoints should be hit
+
+**Electron**
+* TODO