From 861978a2bb69862655350a4d797f95c75ae98552 Mon Sep 17 00:00:00 2001 From: ggetz Date: Fri, 25 May 2018 14:46:47 -0400 Subject: [PATCH 1/4] Add Draco JS module build instructions --- .../Contributors/DracoModuleManagement/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 Documentation/Contributors/DracoModuleManagement/README.md diff --git a/Documentation/Contributors/DracoModuleManagement/README.md b/Documentation/Contributors/DracoModuleManagement/README.md new file mode 100644 index 000000000000..dbb93d293b4c --- /dev/null +++ b/Documentation/Contributors/DracoModuleManagement/README.md @@ -0,0 +1,14 @@ +## Updating the Draco JavaScript Decoder Module + +We use a custom build of the [Draco](https://github.com/google/draco) decoder JavaScript module to allow for IE11 compatibility. + +1. Clone the [Draco source code](https://github.com/google/draco). +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`. +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 +``` +5. In that directory, build with `make -j`. +6. Copy the output `draco_decoder.js` file to the `Source\ThirdParty\Workers` directory. From 4a78dc20e9c21d017b2c51d708b95bdc4a6dc956 Mon Sep 17 00:00:00 2001 From: ggetz Date: Fri, 8 Jun 2018 13:33:09 -0400 Subject: [PATCH 2/4] Update draco link --- Documentation/Contributors/DracoModuleManagement/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Contributors/DracoModuleManagement/README.md b/Documentation/Contributors/DracoModuleManagement/README.md index dbb93d293b4c..cead952a7718 100644 --- a/Documentation/Contributors/DracoModuleManagement/README.md +++ b/Documentation/Contributors/DracoModuleManagement/README.md @@ -2,7 +2,7 @@ We use a custom build of the [Draco](https://github.com/google/draco) decoder JavaScript module to allow for IE11 compatibility. -1. Clone the [Draco source code](https://github.com/google/draco). +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`. From 77af2233ba5cd3b724f9d11d87409e85ee3d0ac8 Mon Sep 17 00:00:00 2001 From: ggetz Date: Tue, 12 Jun 2018 11:08:33 -0400 Subject: [PATCH 3/4] Suggest Linux or Linux Subsystem --- .../Contributors/DracoModuleManagement/README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/Documentation/Contributors/DracoModuleManagement/README.md b/Documentation/Contributors/DracoModuleManagement/README.md index cead952a7718..3fd86974c260 100644 --- a/Documentation/Contributors/DracoModuleManagement/README.md +++ b/Documentation/Contributors/DracoModuleManagement/README.md @@ -2,13 +2,15 @@ We use a custom build of the [Draco](https://github.com/google/draco) decoder JavaScript module to allow for IE11 compatibility. -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`. + +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). +3. [Download and install Emscripten](https://kripken.github.io/emscripten-site/docs/getting_started/downloads.html) 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 +cmake ..\path\to\draco -G "Unix Makefiles" -DCMAKE_TOOLCHAIN_FILE="absolute\path\emscripten\cmake\Modules\Platforms\Emscripten.cmake" -DIE_COMPATIBLE=true ``` 5. In that directory, build with `make -j`. 6. Copy the output `draco_decoder.js` file to the `Source\ThirdParty\Workers` directory. From be36169efe6437d279e503706983816596f9d35f Mon Sep 17 00:00:00 2001 From: ggetz Date: Tue, 12 Jun 2018 11:44:19 -0400 Subject: [PATCH 4/4] Clarify an official release --- Documentation/Contributors/DracoModuleManagement/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Contributors/DracoModuleManagement/README.md b/Documentation/Contributors/DracoModuleManagement/README.md index 3fd86974c260..05544a1e4ec7 100644 --- a/Documentation/Contributors/DracoModuleManagement/README.md +++ b/Documentation/Contributors/DracoModuleManagement/README.md @@ -6,7 +6,7 @@ We use a custom build of the [Draco](https://github.com/google/draco) decoder Ja 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). +2. Download (or checkout the tag of) an official [Draco release](https://github.com/google/draco/releases). 3. [Download and install Emscripten](https://kripken.github.io/emscripten-site/docs/getting_started/downloads.html) 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