Skip to content

Commit 0749730

Browse files
Update WASM README.md (#61681)
* Update WASM README.md
1 parent 293e5ed commit 0749730

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

src/mono/wasm/README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This depends on `emsdk` to be installed.
44

5-
## emsdk on mac
5+
## emsdk on macOS
66

77
* You can run `make provision-wasm`, which will install it to `$reporoot/src/mono/wasm/emsdk` .
88
Note: Irrespective of `$(EMSDK_PATH)`'s value, `provision-wasm` will always install into `$reporoot/src/mono/wasm/emsdk`.
@@ -17,13 +17,7 @@ Do not install `latest` but rather specific version e.g. `./emsdk install 2.0.23
1717

1818
Make sure to set `EMSDK_PATH` variable, whenever building, or running tests for wasm.
1919

20-
### Windows dependencies
21-
22-
Windows build [requirements](https://github.com/dotnet/runtime/blob/main/docs/workflow/requirements/windows-requirements.md)
23-
24-
If `EMSDK_PATH` is not set, the `emsdk` should be provisioned automatically during the build.
25-
26-
## Building on mac
20+
## Building on macOS
2721

2822
* To build the whole thing, with libraries:
2923

@@ -33,9 +27,17 @@ If `EMSDK_PATH` is not set, the `emsdk` should be provisioned automatically duri
3327

3428
`make runtime`
3529

36-
### Note: Additional msbuild arguments can be passed with: `make build-all MSBUILD_ARGS="/p:a=b"`
30+
**Note:** Additional msbuild arguments can be passed with: `make build-all MSBUILD_ARGS="/p:a=b"`
31+
32+
## emsdk on Windows
33+
34+
Windows build [requirements](https://github.com/dotnet/runtime/blob/main/docs/workflow/requirements/windows-requirements.md)
35+
36+
If `EMSDK_PATH` is not set, the `emsdk` should be provisioned automatically during the build.
37+
38+
**Note:** The EMSDK has an implicit dependency on Python for it to be initialized. A consequence of this is that if the system doesn't have Python installed prior to attempting a build, the automatic provisioning will fail and be in an invalid state. Therefore, if Python needs to be installed after a build attempt the `$reporoot/src/mono/wasm/emsdk` directory should be manually deleted and then a rebuild attempted.
3739

38-
### Bulding on windows
40+
## Bulding on Windows
3941

4042
* To build everything
4143

@@ -47,7 +49,7 @@ If `EMSDK_PATH` is not set, the `emsdk` should be provisioned automatically duri
4749

4850
The latest engines can be installed with jsvu (JavaScript engine Version Updater https://github.com/GoogleChromeLabs/jsvu)
4951

50-
### Mac
52+
### macOS
5153

5254
* Install npm with brew:
5355

@@ -83,7 +85,7 @@ Add `~/.jsvu` to your `PATH`:
8385

8486
Library tests can be run with js engines: `v8`, `SpiderMonkey`,or `JavaScriptCore`:
8587

86-
### Mac
88+
### macOS
8789

8890
* `v8`: `make run-tests-v8-$(lib_name)`
8991
* SpiderMonkey: `make run-tests-sm-$(lib_name)`
@@ -105,7 +107,7 @@ Examples of running tests for individual libraries:
105107
`.\dotnet.cmd build /t:Test /p:TargetOS=Browser src\libraries\System.Collections.Concurrent\tests`
106108
`.\dotnet.cmd build /t:Test /p:TargetOS=Browser /p:JSEngine="SpiderMonkey" src\libraries\System.Text.Json\tests`
107109

108-
### Browser tests on mac
110+
### Browser tests on macOS
109111

110112
Or they can be run with a browser (Chrome):
111113

@@ -125,9 +127,9 @@ The wrapper script used to actually run these tests, accepts:
125127

126128
* set `XHARNESS_CLI_PATH=/path/to/xharness/artifacts/bin/Microsoft.DotNet.XHarness.CLI/Debug/netcoreapp3.1/Microsoft.DotNet.XHarness.CLI.dll`
127129

128-
### Note: Additional msbuild arguments can be passed with: `make .. MSBUILD_ARGS="/p:a=b"`
130+
**Note:** Additional msbuild arguments can be passed with: `make .. MSBUILD_ARGS="/p:a=b"`
129131

130-
## Debugger tests on mac
132+
## Debugger tests on macOS
131133

132134
Debugger tests need `Google Chrome` to be installed.
133135

@@ -173,4 +175,4 @@ Bumping Emscripten version involves these steps:
173175
## Code style
174176
* Is enforced via [eslint](https://eslint.org/) and rules are in `./.eslintrc.js`
175177
* You could check the style by running `npm run lint` in `src/mono/wasm/runtime` directory
176-
* You can install [plugin into your VS Code](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) to show you the errors as you type
178+
* You can install [plugin into your VS Code](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) to show you the errors as you type

0 commit comments

Comments
 (0)