From 387d5c1673cb6fd1ecfe25673d385ebb15392704 Mon Sep 17 00:00:00 2001 From: James Sturtevant Date: Mon, 3 Jun 2024 15:09:13 -0700 Subject: [PATCH] Add notes on how to build the project Signed-off-by: James Sturtevant --- CONTRIBUTING.md | 26 ++++++++++++++++++- README.md | 3 +++ .../build/WasmComponent.Sdk.targets | 4 ++- 3 files changed, 31 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 54077b6..2337951 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,27 @@ -We are currently working on improving the contributor experience. Bug fixes and new features must be submitted using a pull request. +# Submitting bugs and fixes +Open an issue detailing the issue you've encountered or feature you would like to see. +Bug fixes and new features must be submitted using a pull request and pass CI to be included in the project. + +## Building the project locally + +Requires [.NET 8+](https://dotnet.microsoft.com/en-us/download) + +``` +dotnet msbuild src/WasmComponent.Sdk/build/WasmComponent.Sdk.targets /t:PrepareWasmSdks +git submodule update --init +dotnet build +``` + +If you are experiencing issues with values not being updated, try running `dotnet clean` and using the steps above + +## Testing + +Run the tests: + +``` +dotnet test +``` + +## Getting help While we work on improving the documentation for contributing, if you have any questions please drop a note in the [c# zulip chat](https://bytecodealliance.zulipchat.com/#narrow/stream/407028-C.23.2F.2Enet-collaboration). \ No newline at end of file diff --git a/README.md b/README.md index b3dd74d..3ea4d43 100644 --- a/README.md +++ b/README.md @@ -205,3 +205,6 @@ This is a wrapper around various other bits of tooling: * [WASI SDK](https://github.com/WebAssembly/wasi-sdk) and [Emscripten](https://emscripten.org/), both of which are used by NativeAOT-LLVM. * Compatible versions of these will be downloaded and cached on your machine the first time you run a build, so the first build will take a few minutes. After that it will only take seconds. +## Contributing + +See our [contributing docs](./CONTRIBUTING.md) for details on how to build and contribute to this project. \ No newline at end of file diff --git a/src/WasmComponent.Sdk/build/WasmComponent.Sdk.targets b/src/WasmComponent.Sdk/build/WasmComponent.Sdk.targets index c88d257..1b42574 100644 --- a/src/WasmComponent.Sdk/build/WasmComponent.Sdk.targets +++ b/src/WasmComponent.Sdk/build/WasmComponent.Sdk.targets @@ -14,7 +14,9 @@ 3.1.23 https://github.com/emscripten-core/emsdk/archive/refs/tags/$(EmSdkVersion).zip - $([System.IO.Path]::Combine("$([System.Environment]::GetFolderPath(SpecialFolder.UserProfile))", ".emsdk", "emsdk-$(EmSdkVersion)")) + + $([System.IO.Path]::Combine("$([System.Environment]::GetFolderPath(SpecialFolder.UserProfile))", ".emsdk", "emsdk-$(EmSdkVersion)")) + $(EMSDK)