Skip to content

Commit

Permalink
docs(#4): 📝 Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gautegf committed Oct 23, 2025
1 parent 1350936 commit 681caeb
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <http://localhost:5173> to view the app.

### Build for Production
Expand All @@ -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.

0 comments on commit 681caeb

Please sign in to comment.