make emsdk installation instructions clear on which version need to be installed...
authorPavel Savara <pavelsavara@microsoft.com>
Mon, 12 Apr 2021 15:17:20 +0000 (17:17 +0200)
committerGitHub <noreply@github.com>
Mon, 12 Apr 2021 15:17:20 +0000 (11:17 -0400)
* make emsdk installation instructions clear on which version need to be installed

* whitespace

* Radek's feedback

docs/workflow/building/libraries/webassembly-instructions.md
src/mono/wasm/README.md

index 315611d..4200462 100644 (file)
@@ -4,7 +4,10 @@
 
 If you haven't already done so, please read [this document](../../README.md#Build_Requirements) to understand the build requirements for your operating system.
 
-The Emscripten SDK (emsdk) needs to be installed.  Follow the installation guide [here](https://emscripten.org/docs/getting_started/downloads.html#sdk-download-and-install) or run `make -C src/mono/wasm provision-wasm` to install emsdk into `src/mono/wasm/emsdk`.
+The **correct version** of Emscripten SDK (emsdk) needs to be installed.
+* Run `make -C src/mono/wasm provision-wasm` to install emsdk into `src/mono/wasm/emsdk`.
+* Alternatively follow the [installation guide](https://emscripten.org/docs/getting_started/downloads.html#sdk-download-and-install).
+Do not install `latest` but rather specific version e.g. `./emsdk install 2.0.12`. See [emscripten-version.txt](..\..\..\..\src\mono\wasm\emscripten-version.txt)
 
 Once installed the `EMSDK_PATH` environment variable needs to be set:
 
index e2101b6..3e90f47 100644 (file)
@@ -4,9 +4,7 @@ This depends on `emsdk` to be installed.
 
 ## emsdk
 
-* You can either install it yourself (https://emscripten.org/docs/getting_started/downloads.html), and set `EMSDK_PATH` to that. Make sure to have this set whenever building, or running tests for wasm.
-
-* Or you can run `make provision-wasm`, which will install it to `$reporoot/src/mono/wasm/emsdk`.
+* You can run `make provision-wasm`, which will install it to `$reporoot/src/mono/wasm/emsdk`.
 Note: Irrespective of `$(EMSDK_PATH)`'s value, `provision-wasm` will always install into `$reporoot/src/mono/wasm/emsdk`.
 
 `EMSDK_PATH` is set to `$reporoot/src/mono/wasm/emsdk` by default, by the Makefile.
@@ -14,6 +12,11 @@ Note: Irrespective of `$(EMSDK_PATH)`'s value, `provision-wasm` will always inst
 Note: `EMSDK_PATH` is set by default in `src/mono/wasm/Makefile`, so building targets from that will have it set. But you might need to set it manually if
 you are directly using the `dotnet build`, or `build.sh`.
 
+* Alternatively you can install **correct version** yourself from the [Emscripten SDK guide](https://emscripten.org/docs/getting_started/downloads.html).
+Do not install `latest` but rather specific version e.g. `./emsdk install 2.0.12`. See [emscripten-version.txt](./emscripten-version.txt)
+
+Make sure to set `EMSDK_PATH` variable, whenever building, or running tests for wasm.
+
 ### Windows dependencies
 
 Windows build [requirements](https://github.com/dotnet/runtime/blob/main/docs/workflow/requirements/windows-requirements.md)