diff --git a/README.md b/README.md index 4b963ae..a2169a2 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 | 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) | -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' . 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 + + + +