[tests] Add docs for WasmTests

dotnet · Mar 6, 2024 · 63626bb · 63626bb
1 parent b5fc059
commit 63626bb
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/tests/BenchmarkDotNet.IntegrationTests/WasmTests.cs b/tests/BenchmarkDotNet.IntegrationTests/WasmTests.cs
@@ -13,10 +13,16 @@
 
 namespace BenchmarkDotNet.IntegrationTests
 {
-    public class WasmTests : BenchmarkTestExecutor
+    /// <summary>
+    /// In order to run WasmTests locally, the following prerequisites are required:
+    /// * Install wasm-tools workload: `BenchmarkDotNet/build.cmd install-wasm-tools`
+    /// * Install npm
+    /// * Install v8: `npm install jsvu -g && jsvu --os=default --engines=v8`
+    /// * Add `$HOME/.jsvu/bin` to PATH
+    /// * Run tests using .NET SDK from `BenchmarkDotNet/.dotnet/`
+    /// </summary>
+    public class WasmTests(ITestOutputHelper output) : BenchmarkTestExecutor(output)
     {
-        public WasmTests(ITestOutputHelper output) : base(output) { }
-
         [FactEnvSpecific("WASM is only supported on Unix", EnvRequirement.NonWindows)]
         public void WasmIsSupported()
         {