From 5e4097b1fea57fa9c85236460df6370af1785bac Mon Sep 17 00:00:00 2001 From: Dan Balasescu Date: Fri, 20 Jun 2025 03:00:28 +0900 Subject: [PATCH] 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' .