Move build instructions to README.md

This commit is contained in:
Ryan Harrison 2019-08-09 10:27:45 -04:00
parent c96e42dca8
commit 734176a25c
2 changed files with 16 additions and 14 deletions

View File

@ -1,14 +0,0 @@
Build as usual (see `README.md`), but:
* Need `emsdk` in your *PATH*
+ Instructions located
[here](https://emscripten.org/docs/getting_started/downloads.html#sdk-download-and-install)
* Do not checkout SPIRV-Tools into External/
+ Does not work correctly with emscripten out of the box and we don't want
it in the build anyway.
+ *TBD* Add flag to disable SPIRV-Tool inclusion even if directory is
present.
* Wrap call to `cmake` using `emconfigure`:
+ e.g. `emconfigure cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_GLSLANG_WEB=ON
-DENABLE_HLSL=OFF -DCMAKE_INSTALL_PREFIX="$(pwd)/install" ..`
+ To get a 'true' size, make sure to use `brotli` to compress the .js and .wasm files

View File

@ -163,6 +163,22 @@ bison --defines=MachineIndependent/glslang_tab.cpp.h
The above command is also available in the bash script at
`glslang/updateGrammar`.
### WASM for the the Web
Use the steps in [Build Steps](#build-steps), which following notes/exceptions:
* `emsdk` needs to be present in your executable search path, *PATH* for
Bash-like enivironments
+ Instructions located
[here](https://emscripten.org/docs/getting_started/downloads.html#sdk-download-and-install)
* Do not checkout SPIRV-Tools into `External`
+ Does not work correctly with emscripten out of the box and we don't want it
in the build anyway. *TBD* Have build ignore SPIRV-Tools for web build
* Wrap call to `cmake` using `emconfigure` with ENABLE_GLSLANG_WEB=ON:
+ e.g. For Linux, `emconfigure cmake -DCMAKE_BUILD_TYPE=Release
-DENABLE_GLSLANG_WEB=ON -DCMAKE_INSTALL_PREFIX="$(pwd)/install" ..`
* To get a 'true' minimized build, make sure to use `brotli` to compress the .js
and .wasm files
Testing
-------