From aa0309b68e9b3a4c04cf768297020c95d1334e25 Mon Sep 17 00:00:00 2001 From: Jim Eckerlein Date: Tue, 27 Feb 2024 17:43:00 +0100 Subject: [PATCH] update readme --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7fce27ac..080ffc89 100644 --- a/README.md +++ b/README.md @@ -65,13 +65,13 @@ Setup For local usage and debugging, please follow these instructions: -0. Make sure [Git LFS](https://git-lfs.github.com) is installed. +1. Make sure [Git LFS](https://git-lfs.github.com) is installed. -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 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` +3. Change into the `app_web` directory -3. To build the npm package for publishing: +4. To build the npm package for publishing: - run `npm install` - run `npm run build` @@ -88,7 +88,7 @@ More detailed information about the API is listed in the [api documentation](API ### GltfView -The GltfView component is associated with one WebGL2 context. In practice this means it will be associated with one HTML5 Canvas. This component manages the interaction between the canvas and the GL context. For example it therefore specifies the viewport, the swapchain and can be used to schedule frame renders. +The GltfView component is associated with one WebGL2 context. In practice this means it will be associated with one HTML5 Canvas. This component manages the interaction between the canvas and the GL context. For example it therefore specifies the viewport, the swapchain and can be used to schedule frame renders. ```js const view = new GltfView(webGl2Context); @@ -136,7 +136,7 @@ You can find an example application for the gltf viewer in the [app_web subdirec Open a terminal window in the repository root an run the following commands ``` cd app_web -npm install +npm install npm run dev ```