From 7fb5b29f507340d0e537ec5ab9ad7b2b482811d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Schmith=C3=BCsen?= Date: Wed, 14 Nov 2018 10:15:34 +0100 Subject: [PATCH 1/4] added a setup guide for working with the reference viewer --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index a1bb689e..8ac35e25 100644 --- a/README.md +++ b/README.md @@ -227,3 +227,18 @@ Features - [ ] 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`](../blob/reference-viewer) branch +* Pull the submodule if you want the example assets + +**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 \ No newline at end of file From 2cffbc0a3237c420af83c2d914cb64eceecd8ca6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Schmith=C3=BCsen?= Date: Wed, 14 Nov 2018 10:16:12 +0100 Subject: [PATCH 2/4] ticked some more features that have been integrated already --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8ac35e25..7513f1e7 100644 --- a/README.md +++ b/README.md @@ -223,8 +223,8 @@ 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 From 3514156e2cd8ae47ff635b037615201c0297254e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Schmith=C3=BCsen?= Date: Wed, 14 Nov 2018 10:20:45 +0100 Subject: [PATCH 3/4] fixed a link in the readme file --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7513f1e7..d2f3e45c 100644 --- a/README.md +++ b/README.md @@ -231,7 +231,7 @@ Features Setup ----- **General** -* Checkout the [`reference-viewer`](../blob/reference-viewer) branch +* Checkout the [`reference-viewer`](../../tree/reference-viewer) branch * Pull the submodule if you want the example assets **Debugging** From 9af2ad3b5dc37c77e14f40a7e0d4fd581b958128 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Schmith=C3=BCsen?= Date: Wed, 14 Nov 2018 10:38:41 +0100 Subject: [PATCH 4/4] added the command for pulling the submodule --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d2f3e45c..9955178c 100644 --- a/README.md +++ b/README.md @@ -232,7 +232,7 @@ Setup ----- **General** * Checkout the [`reference-viewer`](../../tree/reference-viewer) branch -* Pull the submodule if you want the example assets +* 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)