Skip to content

Commit 9c42984

Browse files
authored
Some minor README.md corrections. (#2116)
1 parent fe20742 commit 9c42984

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -73,24 +73,26 @@ In addition, the Silk.NET working group help drive larger user-facing changes pr
7373

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

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

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

91-
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`.
88+
- Clone the repository
89+
- Note: Avoid performing a recursive clone as the submodules are not necessary for a normal build
90+
- Run `build.sh`, `build.cmd`, `build.ps1`, or `nuke compile`
91+
- On Linux, you may need to pass `--msbuild-properties AndroidSdkDirectory=/path/to/android/sdk`
92+
- Use the built assemblies
93+
- To get `.nupkg`s that you can use with NuGet instead, use `nuke pack`
9294

93-
Note: Some .NET 6 workloads are only supported on Windows and macOS today.
95+
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`.
9496

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

0 commit comments

Comments
 (0)