Skip to content

Commit b3a97cb

Browse files
authored
Merge pull request #3 from jsturtevant/building-local
Add notes on how to build the project
2 parents cf44e74 + 387d5c1 commit b3a97cb

File tree

3 files changed

+31
-2
lines changed

3 files changed

+31
-2
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
1-
We are currently working on improving the contributor experience. Bug fixes and new features must be submitted using a pull request.
1+
# Submitting bugs and fixes
2+
Open an issue detailing the issue you've encountered or feature you would like to see.
23

4+
Bug fixes and new features must be submitted using a pull request and pass CI to be included in the project.
5+
6+
## Building the project locally
7+
8+
Requires [.NET 8+](https://dotnet.microsoft.com/en-us/download)
9+
10+
```
11+
dotnet msbuild src/WasmComponent.Sdk/build/WasmComponent.Sdk.targets /t:PrepareWasmSdks
12+
git submodule update --init
13+
dotnet build
14+
```
15+
16+
If you are experiencing issues with values not being updated, try running `dotnet clean` and using the steps above
17+
18+
## Testing
19+
20+
Run the tests:
21+
22+
```
23+
dotnet test
24+
```
25+
26+
## Getting help
327
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).

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,3 +205,6 @@ This is a wrapper around various other bits of tooling:
205205
* [WASI SDK](https://github.com/WebAssembly/wasi-sdk) and [Emscripten](https://emscripten.org/), both of which are used by NativeAOT-LLVM.
206206
* 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.
207207

208+
## Contributing
209+
210+
See our [contributing docs](./CONTRIBUTING.md) for details on how to build and contribute to this project.

src/WasmComponent.Sdk/build/WasmComponent.Sdk.targets

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@
1414

1515
<EmSdkVersion>3.1.23</EmSdkVersion>
1616
<EmSdkUrl>https://github.com/emscripten-core/emsdk/archive/refs/tags/$(EmSdkVersion).zip</EmSdkUrl>
17-
<EmscriptenRoot>$([System.IO.Path]::Combine("$([System.Environment]::GetFolderPath(SpecialFolder.UserProfile))", ".emsdk", "emsdk-$(EmSdkVersion)"))</EmscriptenRoot>
17+
<!-- Support bring your own emscripten if $(EMSDK) is already set-->
18+
<EmscriptenRoot Condition="'$(EMSDK)' == ''">$([System.IO.Path]::Combine("$([System.Environment]::GetFolderPath(SpecialFolder.UserProfile))", ".emsdk", "emsdk-$(EmSdkVersion)"))</EmscriptenRoot>
19+
<EmscriptenRoot Condition="'$(EMSDK)' != ''">$(EMSDK)</EmscriptenRoot>
1820
</PropertyGroup>
1921

2022
<Target Name="EmitWasmOnBuild" AfterTargets="CopyFilesToOutputDirectory" DependsOnTargets="LinkNativeLlvm; ConvertToWasmComponent"

0 commit comments

Comments
 (0)