Skip to content

Commit 47bf30b

Browse files
authored
Update README.md
1 parent d7a8624 commit 47bf30b

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,27 @@
1-
A .NET Wrapper for SDL2 (v 2.30.6)
1+
# Hexa.NET.SDL2
2+
3+
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.
4+
5+
## Features
6+
7+
- **Minimal Wrapper**: Provides a direct, 1:1 mapping to the SDL2 C functions, staying true to the original API.
8+
- **Cross-Platform Compatibility**: Works across all platforms supported by SDL2, including Windows, Linux, Android, and macOS.
9+
- **Pre-Built Native Libraries**: The package includes pre-built native libraries, so you don't need to worry about installing SDL2 separately.
10+
11+
## Installation
12+
13+
You can install Hexa.NET.SDL2 via NuGet:
14+
15+
```bash
16+
dotnet add package Hexa.NET.SDL2
17+
```
18+
19+
Alternatively, you can visit the [NuGet package page](https://www.nuget.org/packages/Hexa.NET.SDL2) and follow the instructions there.
20+
21+
## Contributing
22+
23+
Contributions are welcome! If you encounter any issues or have suggestions for improvements, feel free to open an issue or submit a pull request.
24+
25+
## License
26+
27+
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 commit comments

Comments
 (0)