Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add setup guide to README #93

Merged
merged 4 commits into from
Nov 14, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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