Skip to content

Commit 63626bb

Browse files
[tests] Add docs for WasmTests
1 parent b5fc059 commit 63626bb

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

tests/BenchmarkDotNet.IntegrationTests/WasmTests.cs

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,16 @@
1313

1414
namespace BenchmarkDotNet.IntegrationTests
1515
{
16-
public class WasmTests : BenchmarkTestExecutor
16+
/// <summary>
17+
/// In order to run WasmTests locally, the following prerequisites are required:
18+
/// * Install wasm-tools workload: `BenchmarkDotNet/build.cmd install-wasm-tools`
19+
/// * Install npm
20+
/// * Install v8: `npm install jsvu -g && jsvu --os=default --engines=v8`
21+
/// * Add `$HOME/.jsvu/bin` to PATH
22+
/// * Run tests using .NET SDK from `BenchmarkDotNet/.dotnet/`
23+
/// </summary>
24+
public class WasmTests(ITestOutputHelper output) : BenchmarkTestExecutor(output)
1725
{
18-
public WasmTests(ITestOutputHelper output) : base(output) { }
19-
2026
[FactEnvSpecific("WASM is only supported on Unix", EnvRequirement.NonWindows)]
2127
public void WasmIsSupported()
2228
{

0 commit comments

Comments
 (0)