From 5e4097b1fea57fa9c85236460df6370af1785bac Mon Sep 17 00:00:00 2001 From: Dan Balasescu Date: Fri, 20 Jun 2025 03:00:28 +0900 Subject: [PATCH 1/4] Add packages + platforms to README, general improvements --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4b963ae..87101d8 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,26 @@ # SDL3-CS -SDL3-CS is [SDL3](https://github.com/libsdl-org/SDL) bindings, developed for internal use and available publicly on [NuGet.org](https://www.nuget.org/packages/ppy.SDL3-CS). +C# bindings for the [SDL3](https://github.com/libsdl-org/SDL) family of libraries. -## About +| Product | Package | +|------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| [`SDL`](https://github.com/libsdl-org/SDL/tree/main) | [![NuGet](https://img.shields.io/nuget/v/ppy.SDL3-CS?label=ppy.SDL3-CS)](https://www.nuget.org/packages/ppy.SDL3-CS) | +| [`SDL_image`](https://github.com/libsdl-org/SDL_image/tree/main) | [![NuGet](https://img.shields.io/nuget/v/ppy.SDL3_image-CS?label=ppy.SDL3_image-CS)](https://www.nuget.org/packages/ppy.SDL3_image-CS) | +| [`SDL_ttf`](https://github.com/libsdl-org/SDL_ttf/tree/main) | [![NuGet](https://img.shields.io/nuget/v/ppy.SDL3_ttf-CS?label=ppy.SDL3_ttf-CS)](https://www.nuget.org/packages/ppy.SDL3_ttf-CS) | -The library is functional and available for public use. While it is actively maintained, updates are primarily driven by our internal needs. Please set your expectations accordingly when using or adapting SDL3-CS in your own projects. +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. -Contributions to keep the bindings up-to-date with upstream SDL3 changes are welcome. If you have improvements or updates, feel free to submit a pull request. +## Platform support -## Generating Bindings +| Product | `win-x64` | `win-x86` | `win-arm64` | `osx-arm64` | `osx-x64` | `linux-x64` | `linux-x86` | `linux-arm64` | `linux-arm` | `ios` | `android` | +|-----------------|-----------|-----------|-------------|-------------|-----------|-------------|-------------|---------------|-------------|---------|-----------| +| `SDL3-CS` | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| `SDL3_image-CS` | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | | +| `SDL3_ttf-CS` | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | | -Bindings should be generated via the provided Dockerfile: +## Generating bindings + +Bindings are generated via the provided Dockerfile: ```sh docker build -t 'sdl-gen' . From 8172ba94e10b1fc11e763f2ef83436fb440b246c Mon Sep 17 00:00:00 2001 From: Dan Balasescu Date: Fri, 20 Jun 2025 03:20:01 +0900 Subject: [PATCH 2/4] Add CLI usage string --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 87101d8..399d5d5 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ C# bindings for the [SDL3](https://github.com/libsdl-org/SDL) family of libraries. -| Product | Package | -|------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| -| [`SDL`](https://github.com/libsdl-org/SDL/tree/main) | [![NuGet](https://img.shields.io/nuget/v/ppy.SDL3-CS?label=ppy.SDL3-CS)](https://www.nuget.org/packages/ppy.SDL3-CS) | -| [`SDL_image`](https://github.com/libsdl-org/SDL_image/tree/main) | [![NuGet](https://img.shields.io/nuget/v/ppy.SDL3_image-CS?label=ppy.SDL3_image-CS)](https://www.nuget.org/packages/ppy.SDL3_image-CS) | -| [`SDL_ttf`](https://github.com/libsdl-org/SDL_ttf/tree/main) | [![NuGet](https://img.shields.io/nuget/v/ppy.SDL3_ttf-CS?label=ppy.SDL3_ttf-CS)](https://www.nuget.org/packages/ppy.SDL3_ttf-CS) | +| Product | Usage | Package +|------------------------------------------------------------------|----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------- +| [`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=ppy.SDL3-CS)](https://www.nuget.org/packages/ppy.SDL3-CS) +| [`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=ppy.SDL3_image-CS)](https://www.nuget.org/packages/ppy.SDL3_image-CS) +| [`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=ppy.SDL3_ttf-CS)](https://www.nuget.org/packages/ppy.SDL3_ttf-CS) 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. From efe88bd6c0bc3f2951a3177453e3cd85c6dcb91e Mon Sep 17 00:00:00 2001 From: Dan Balasescu Date: Fri, 20 Jun 2025 03:25:42 +0900 Subject: [PATCH 3/4] Remove package name from badges --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 399d5d5..a2169a2 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ C# bindings for the [SDL3](https://github.com/libsdl-org/SDL) family of libraries. -| Product | Usage | Package -|------------------------------------------------------------------|----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------- -| [`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=ppy.SDL3-CS)](https://www.nuget.org/packages/ppy.SDL3-CS) -| [`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=ppy.SDL3_image-CS)](https://www.nuget.org/packages/ppy.SDL3_image-CS) -| [`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=ppy.SDL3_ttf-CS)](https://www.nuget.org/packages/ppy.SDL3_ttf-CS) +| Product | Usage | Package | +|------------------------------------------------------------------|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| [`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) | +| [`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) | +| [`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) | 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. From 9c587389c23206327fdc6ca9f83d88e53621cc49 Mon Sep 17 00:00:00 2001 From: Dan Balasescu Date: Fri, 20 Jun 2025 03:30:22 +0900 Subject: [PATCH 4/4] Add condensed readme to package --- README_nuget.md | 17 +++++++++++++++++ SDL3-CS/SDL3-CS.csproj | 5 +++++ SDL3_image-CS/SDL3_image-CS.csproj | 5 +++++ SDL3_ttf-CS/SDL3_ttf-CS.csproj | 5 +++++ 4 files changed, 32 insertions(+) create mode 100644 README_nuget.md diff --git a/README_nuget.md b/README_nuget.md new file mode 100644 index 0000000..b97a871 --- /dev/null +++ b/README_nuget.md @@ -0,0 +1,17 @@ +C# bindings for the [SDL3](https://github.com/libsdl-org/SDL) family of libraries. + +| Product | Usage | Package | +|------------------------------------------------------------------|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| [`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) | +| [`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) | +| [`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) | + +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. + +## Platform support + +| Product | `win-x64` | `win-x86` | `win-arm64` | `osx-arm64` | `osx-x64` | `linux-x64` | `linux-x86` | `linux-arm64` | `linux-arm` | `ios` | `android` | +|-----------------|-----------|-----------|-------------|-------------|-----------|-------------|-------------|---------------|-------------|---------|-----------| +| `SDL3-CS` | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| `SDL3_image-CS` | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | | +| `SDL3_ttf-CS` | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | | \ No newline at end of file diff --git a/SDL3-CS/SDL3-CS.csproj b/SDL3-CS/SDL3-CS.csproj index a8a6123..0a11df3 100644 --- a/SDL3-CS/SDL3-CS.csproj +++ b/SDL3-CS/SDL3-CS.csproj @@ -19,9 +19,14 @@ Automated release. MIT https://github.com/ppy/SDL3-CS + README_nuget.md https://github.com/ppy/SDL3-CS + + + + diff --git a/SDL3_image-CS/SDL3_image-CS.csproj b/SDL3_image-CS/SDL3_image-CS.csproj index 027c84f..dfa55c3 100644 --- a/SDL3_image-CS/SDL3_image-CS.csproj +++ b/SDL3_image-CS/SDL3_image-CS.csproj @@ -17,9 +17,14 @@ Automated release. MIT https://github.com/ppy/SDL3-CS + README_nuget.md https://github.com/ppy/SDL3-CS + + + + diff --git a/SDL3_ttf-CS/SDL3_ttf-CS.csproj b/SDL3_ttf-CS/SDL3_ttf-CS.csproj index 212a723..3dfa620 100644 --- a/SDL3_ttf-CS/SDL3_ttf-CS.csproj +++ b/SDL3_ttf-CS/SDL3_ttf-CS.csproj @@ -17,9 +17,14 @@ Automated release. MIT https://github.com/ppy/SDL3-CS + README_nuget.md https://github.com/ppy/SDL3-CS + + + +