Skip to content

Commit

Permalink
Some minor README.md corrections. (dotnet#2116)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexrp committed Apr 15, 2024
1 parent fe20742 commit 9c42984
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,24 +73,26 @@ In addition, the Silk.NET working group help drive larger user-facing changes pr

<h1 align="center">Building from source</h1>

Prerequisites
**Prerequisites**

- .NET 6 SDK and .NET 7 SDK
- Android, iOS, and Mac Catalyst workloads (use `dotnet workload install android ios maccatalyst` to install them)
- On Linux, `ios` and `maccatalyst` should be omitted as they are not available
- Android SDK version 30 with NDK tools installed
- On Windows, for best results this should be installed into `C:\ProgramData\Android\android-sdk`
- Java 11 JDK
- Android SDK versions 31, 33, and 34 with NDK tools installed
- On Windows, for best results, this should be installed into `C:\ProgramData\Android\android-sdk`
- Java JDK 11+
- Visual Studio 2022 Community version 17.0 or later (optional)

Instructions
- Clone the repository (recursively)
- Run build.sh, build.cmd, build.ps1, or `nuke compile`.
- On Linux, you may need to pass `--msbuild-properties AndroidSdkDirectory=/path/to/android/sdk`
- Use the DLLs. To get nupkgs you can use with NuGet instead, use `nuke pack`.
**Instructions**

There are more advanced build actions you can do too, such as FullBuild, Pack, FullPack, among others which you can view by doing `nuke --plan`.
- Clone the repository
- Note: Avoid performing a recursive clone as the submodules are not necessary for a normal build
- Run `build.sh`, `build.cmd`, `build.ps1`, or `nuke compile`
- On Linux, you may need to pass `--msbuild-properties AndroidSdkDirectory=/path/to/android/sdk`
- Use the built assemblies
- To get `.nupkg`s that you can use with NuGet instead, use `nuke pack`

Note: Some .NET 6 workloads are only supported on Windows and macOS today.
There are more advanced build actions you can do too, such as `FullBuild`, `Pack`, `FullPack`, among others which you can view by doing `nuke --plan`.

<h1 align="center">Contributing</h1>

Expand Down

0 comments on commit 9c42984

Please sign in to comment.