From 681caeb40ebffa98be802fcce6b04013d70216ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gaute=20Fl=C3=A6gstad?= Date: Thu, 23 Oct 2025 10:43:22 +0200 Subject: [PATCH] docs(#4): :memo: Update readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 518effe..bf8c3f3 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,13 @@ npm install npm run dev ``` +Then in a new terminal run the server: + +```bash +npm run server +``` + + Open your browser at to view the app. ### Build for Production @@ -31,3 +38,12 @@ npm run build ``` The built files will be in the `dist/` folder. + + +## Structure + +### The Potree Build +This application is built using Potree as a package, meaning that the potree build is used as a base layer for UI and functionality and built onto by our own code. The add-ons may use, move or manipulate objects from the potree build, referencing the objects by classname or id. + +### Updating Potree version +To update the version of Potree that this application uses you must make a build from the official potree app and replace the build folder here with the new one. There is no guarantee that Molloy Explorer is compatible with other versions of potree. Make sure that everything works on the development server before applying this to the production server.