Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JunaMeinhold authored Oct 20, 2024
1 parent d7a8624 commit 47bf30b
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,27 @@
A .NET Wrapper for SDL2 (v 2.30.6)
# Hexa.NET.SDL2

Hexa.NET.SDL2 is a minimal C# wrapper for the SDL2 library, providing a thin, 1:1 binding to SDL2's C functions. This wrapper is designed for developers who need direct access to the SDL2 library's functionality from C#, without added complexity or overhead.

## Features

- **Minimal Wrapper**: Provides a direct, 1:1 mapping to the SDL2 C functions, staying true to the original API.
- **Cross-Platform Compatibility**: Works across all platforms supported by SDL2, including Windows, Linux, Android, and macOS.
- **Pre-Built Native Libraries**: The package includes pre-built native libraries, so you don't need to worry about installing SDL2 separately.

## Installation

You can install Hexa.NET.SDL2 via NuGet:

```bash
dotnet add package Hexa.NET.SDL2
```

Alternatively, you can visit the [NuGet package page](https://www.nuget.org/packages/Hexa.NET.SDL2) and follow the instructions there.

## Contributing

Contributions are welcome! If you encounter any issues or have suggestions for improvements, feel free to open an issue or submit a pull request.

## License

Hexa.NET.SDL2 is licensed under the MIT License. See the [LICENSE](https://github.com/HexaEngine/Hexa.NET.SDL2/blob/master/LICENSE.txt) file for more information.

0 comments on commit 47bf30b

Please sign in to comment.