From b6f16e65ba42e086b2882352bdf84fffae07194b Mon Sep 17 00:00:00 2001 From: Mathias Kanzler Date: Fri, 2 Aug 2024 14:31:04 +0200 Subject: [PATCH] Update readme --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d1975c15..bb29324e 100644 --- a/README.md +++ b/README.md @@ -37,16 +37,15 @@ For local usage and debugging, please follow these instructions: 0. Make sure [Git LFS](https://git-lfs.github.com) is installed. -1. Checkout the [`master`](../../tree/master) branch +1. Checkout the [`main`](../../tree/main) branch -2. Pull the submodules for the required [glTF sample models](https://github.com/KhronosGroup/glTF-Sample-Models) and [environments](https://github.com/KhronosGroup/glTF-Sample-Environments) `git submodule update --init --recursive` +2. Pull the submodule for the required [glTF-Sample-Renderer](https://github.com/KhronosGroup/glTF-Sample-Renderer) `git submodule update --init --recursive` 3. Build the web app - - `cd app_web` - run `npm install` - start a demo in the browser with `npm run dev`, and open http://localhost:8000. -When making changes, the project is automatically rebuilt and the `app_web/dist/` directory is populated with the web app. This directory contains all files necessary for deployment to a webserver. +When making changes, the project is automatically rebuilt and the `./dist` directory is populated with the web app. This directory contains all files necessary for deployment to a webserver. Debugging --------- @@ -56,7 +55,7 @@ Debugging * [Chrome](https://www.google.com/chrome/) or [Firefox](https://www.mozilla.org/en-US/firefox/new/) * Install the [Debugger for Chrome](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome) or [Debugger for Firefox](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-firefox-debug) extension for Visual Studio Code * Open the project directory in Visual Studio Code and select `Debug->Add Configuration->Chrome` or `Debug->Add Configuration->Firefox` so the `.vscode/launch.json` file is created. -* Append `/app_web/dist` to `${workspaceFolder}` in the `launch.json` file +* Append `/dist` to `${workspaceFolder}` in the `launch.json` file * `Debug->Start Debugging` should now launch a Chrome or Firefox window with the sample viewer and VS Code breakpoints should be hit. ### Known Issues