Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README information #42

Merged
merged 1 commit into from
Aug 13, 2024
Merged

Update README information #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ cd glue-ar
pip install . # Use `pip install -e .` to install in editable mode
```

Installation requires Node.js to be installed on your system, as we currently use JavaScript packages for performing
Draco and Meshopt compression. (Having Node installed is all that you need - the npm/JS management relevant for the
package is all handled by the package build process).


## Viewer tools

Expand All @@ -35,8 +39,10 @@ has no additional dependencies and can be served using static file hosting.
## Draco compression

The files exported by glue-ar can, in their original form, be quite large. In order to mitigate this problem, glue-ar allows using
[Draco compression](https://google.github.io/draco/) via the [gltf-pipeline](https://github.com/CesiumGS/gltf-pipeline) package. Using Draco compression
allows for a considerable reduction in file size (often an order of magnitude or more), and Draco-compressed files can be read by model-viewer.
[Draco compression](https://google.github.io/draco/) via the [`gltf-pipeline`](https://github.com/CesiumGS/gltf-pipeline) package, or
[Mshopt](https://meshoptimizer.org/) via the [`gltfpack`](https://meshoptimizer.org/gltf/) package.
These compression methods allow for a considerable reduction in file size (often an order of magnitude or more),
and files compression by both methods can be read by model-viewer.

## CoSpaces

Expand All @@ -56,5 +62,5 @@ To create a scene with your newly-exported figure, do the following:
* MERGE Cube > Empty scene to use the MERGE Cube (note that creating a MERGE Cube requires a plan addon)
5. In the bottom left corner, select Upload > 3D models, then press the Upload button to the right
6. Select your 3D model
* Note that CoSpaces currently does not support the extension needed for Draco compression
* Note that CoSpaces currently does not support the extensions needed for Draco or Meshopt compression
7. Done!