Skip to content

Commit 9c58738

Browse files
committed
Add condensed readme to package
1 parent efe88bd commit 9c58738

File tree

4 files changed

+32
-0
lines changed

4 files changed

+32
-0
lines changed

README_nuget.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
C# bindings for the [SDL3](https://github.com/libsdl-org/SDL) family of libraries.
2+
3+
| Product | Usage | Package |
4+
|------------------------------------------------------------------|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
5+
| [`SDL`](https://github.com/libsdl-org/SDL/tree/main) | `dotnet add package ppy.SDL3-CS` | [![NuGet](https://img.shields.io/nuget/v/ppy.SDL3-CS?label=nuget)](https://www.nuget.org/packages/ppy.SDL3-CS) |
6+
| [`SDL_image`](https://github.com/libsdl-org/SDL_image/tree/main) | `dotnet add package ppy.SDL3_image-CS` | [![NuGet](https://img.shields.io/nuget/v/ppy.SDL3_image-CS?label=nuget)](https://www.nuget.org/packages/ppy.SDL3_image-CS) |
7+
| [`SDL_ttf`](https://github.com/libsdl-org/SDL_ttf/tree/main) | `dotnet add package ppy.SDL3_ttf-CS` | [![NuGet](https://img.shields.io/nuget/v/ppy.SDL3_ttf-CS?label=nuget)](https://www.nuget.org/packages/ppy.SDL3_ttf-CS) |
8+
9+
Contributions to keep the bindings up-to-date with upstream changes are welcome. If you have improvements or updates, feel free to submit a pull request.
10+
11+
## Platform support
12+
13+
| Product | `win-x64` | `win-x86` | `win-arm64` | `osx-arm64` | `osx-x64` | `linux-x64` | `linux-x86` | `linux-arm64` | `linux-arm` | `ios` | `android` |
14+
|-----------------|-----------|-----------|-------------|-------------|-----------|-------------|-------------|---------------|-------------|---------|-----------|
15+
| `SDL3-CS` | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
16+
| `SDL3_image-CS` | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | |
17+
| `SDL3_ttf-CS` | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | |

SDL3-CS/SDL3-CS.csproj

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,14 @@
1919
<PackageReleaseNotes>Automated release.</PackageReleaseNotes>
2020
<PackageLicenseExpression>MIT</PackageLicenseExpression>
2121
<PackageProjectUrl>https://github.com/ppy/SDL3-CS</PackageProjectUrl>
22+
<PackageReadmeFile>README_nuget.md</PackageReadmeFile>
2223
<RepositoryUrl>https://github.com/ppy/SDL3-CS</RepositoryUrl>
2324
</PropertyGroup>
2425

26+
<ItemGroup>
27+
<None Include="$(MSBuildThisFileDirectory)..\README_nuget.md" Pack="true" PackagePath="\"/>
28+
</ItemGroup>
29+
2530
<ItemGroup>
2631
<ProjectReference Include="..\SDL3-CS.SourceGeneration\SDL3-CS.SourceGeneration.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false"/>
2732
</ItemGroup>

SDL3_image-CS/SDL3_image-CS.csproj

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,14 @@
1717
<PackageReleaseNotes>Automated release.</PackageReleaseNotes>
1818
<PackageLicenseExpression>MIT</PackageLicenseExpression>
1919
<PackageProjectUrl>https://github.com/ppy/SDL3-CS</PackageProjectUrl>
20+
<PackageReadmeFile>README_nuget.md</PackageReadmeFile>
2021
<RepositoryUrl>https://github.com/ppy/SDL3-CS</RepositoryUrl>
2122
</PropertyGroup>
2223

24+
<ItemGroup>
25+
<None Include="$(MSBuildThisFileDirectory)..\README_nuget.md" Pack="true" PackagePath="\"/>
26+
</ItemGroup>
27+
2328
<ItemGroup>
2429
<ProjectReference Include="..\SDL3-CS.SourceGeneration\SDL3-CS.SourceGeneration.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false"/>
2530
<ProjectReference Include="..\SDL3-CS\SDL3-CS.csproj"/>

SDL3_ttf-CS/SDL3_ttf-CS.csproj

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,14 @@
1717
<PackageReleaseNotes>Automated release.</PackageReleaseNotes>
1818
<PackageLicenseExpression>MIT</PackageLicenseExpression>
1919
<PackageProjectUrl>https://github.com/ppy/SDL3-CS</PackageProjectUrl>
20+
<PackageReadmeFile>README_nuget.md</PackageReadmeFile>
2021
<RepositoryUrl>https://github.com/ppy/SDL3-CS</RepositoryUrl>
2122
</PropertyGroup>
2223

24+
<ItemGroup>
25+
<None Include="$(MSBuildThisFileDirectory)..\README_nuget.md" Pack="true" PackagePath="\"/>
26+
</ItemGroup>
27+
2328
<ItemGroup>
2429
<ProjectReference Include="..\SDL3-CS.SourceGeneration\SDL3-CS.SourceGeneration.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false"/>
2530
<ProjectReference Include="..\SDL3-CS\SDL3-CS.csproj"/>

0 commit comments

Comments
 (0)