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.

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

Draco js module build instructions #6672

Merged
merged 4 commits into from
Jun 13, 2018
Merged

Conversation

ggetz
Copy link
Contributor

@ggetz ggetz commented Jun 8, 2018

Added instructions for updating the draco module, following PR with update to draco build options: google/draco#405

@ggetz ggetz requested a review from mramato June 8, 2018 17:36
@cesium-concierge
Copy link

Signed CLA is on file.

@ggetz, thanks for the pull request! Maintainers, we have a signed CLA from @ggetz, so you can review this at any time.

⚠️ I noticed that CHANGES.md has not been updated. If this change updates the public API in any way, fixes a bug, or makes any non-trivial update, please add a bullet point to CHANGES.md and comment on this pull request so we know it was updated. For more info, see the Pull Request Guidelines.


I am a bot who helps you make Cesium awesome! Contributions to my configuration are welcome.

🌍 🌎 🌏

Copy link
Contributor

@lilleyse lilleyse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can confirm that the steps work. Thanks @ggetz.

1. Clone or download the [Draco release](https://github.com/google/draco/releases).
2. [Download and install Emscripten](https://kripken.github.io/emscripten-site/docs/getting_started/downloads.html)
3. Download and install a make tool.
* For instance, [MSYS2](http://www.msys2.org/). Follow installation instructions and add the path to MSYS2's usr/bin to your `PATH`. For example, if the path is `C:\msys64\usr\bin`, run `PATH=%PATH%;C:\msys64\usr\bin`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we instead just recommend using Linux to build, and point to Ubuntu 18.04 Subsystem for Windows users? I found the build process easier there.

* For instance, [MSYS2](http://www.msys2.org/). Follow installation instructions and add the path to MSYS2's usr/bin to your `PATH`. For example, if the path is `C:\msys64\usr\bin`, run `PATH=%PATH%;C:\msys64\usr\bin`.
4. In a seperate directory, follow the [CMake JavaScript Encoder/Decoder Instructions](https://github.com/google/draco#javascript-encoderdecoder). When running cmake, specify `"Unix Makefiles"` as the target, and including the flag `-DIE_COMPATIBLE=true`, ie.
```terminal
cmake ..\path\to\draco -G "Unix Makefiles" -DCMAKE_TOOLCHAIN_FILE="absolute\path\emscripten\cmake\Modules\Platforms\Emscripten.cmake" -DIE_COMPATIBLE
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-DIE_COMPATIBLE is missing =true

@ggetz
Copy link
Contributor Author

ggetz commented Jun 12, 2018

Thanks @lilleyse, updated!

Added a line preferring Linux or the subsystem, but left previous instructions as an optional backup.

@lilleyse
Copy link
Contributor

Looks good. Does anyone else have feedback or want to try this out?

@mramato
Copy link
Contributor

mramato commented Jun 12, 2018

Looks good to me. Sounds like building is trivial if you're already familiar with cmake/unix dev tools. Thanks @ggetz!

1. Download and install a make tool.
* Preferably, use Linux or [the Linux Subsystem for Windows 10](https://docs.microsoft.com/en-us/windows/wsl/install-win10) and `make` to build.
* Optionally, [MSYS2](http://www.msys2.org/). Follow installation instructions and add the path to MSYS2's usr/bin to your `PATH`. For example, if the path is `C:\msys64\usr\bin`, run `PATH=%PATH%;C:\msys64\usr\bin`.
2. Clone or download the [Draco release](https://github.com/google/draco/releases).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, one comment. If you clone Draco from git, you'll get master and not an official release, right? We should probably always include an official release in Cesium

@ggetz
Copy link
Contributor Author

ggetz commented Jun 12, 2018

Thanks @mramato. Meant to imply that, but it wasn't particularly clear so I made it more explicit.

@lilleyse
Copy link
Contributor

The updated wording looks good to me.

@lilleyse lilleyse merged commit 5ead108 into master Jun 13, 2018
@lilleyse lilleyse deleted the draco-js-module-instructions branch June 13, 2018 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants