From e16457faf01d1bf4bd282082c3b7a0dcd583ecc9 Mon Sep 17 00:00:00 2001 From: Taha Ababou <91101476+tahababou12@users.noreply.github.com> Date: Tue, 28 Nov 2023 05:41:52 -0500 Subject: [PATCH] Update README.md Clarified in README on how to run the project --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 6f7a1a2..accc41a 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,23 @@ Clone the repository and open `index.html` in your browser to start exploring th ``` git clone https://github.com/bgstaal/multipleWindow3dScene ``` + +Make sure that you have http-server installed globally. +``` +$ npm i -g http-server +``` + ## Usage The main application logic is contained within `main.js` and `WindowManager.js`. The 3D scene is rendered in `index.html`, which serves as the entry point of the application. +``` +$ cd multipleWindow3dScene +``` +Run the project using `http-server`. +``` +$ http-server +``` + ## Structure and Components - `index.html`: Entry point that sets up the HTML structure and includes the Three.js library and the main script. - `WindowManager.js`: Core class managing window creation, synchronization, and state management across multiple windows.