Browse Source

Added README.

improved_timing
Ian Burgmyer 7 years ago
parent
commit
605b0192bc
  1. 1
      DotSDL.sln
  2. 31
      README.md

1
DotSDL.sln

@ -6,6 +6,7 @@ MinimumVisualStudioVersion = 10.0.40219.1
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{53C506CE-9D99-4306-A304-D4B09924A883}"
ProjectSection(SolutionItems) = preProject
LICENSE.txt = LICENSE.txt
README.md = README.md
EndProjectSection
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DotSDL", "DotSDL\DotSDL.csproj", "{C645C551-C6A4-4312-BCAF-DF94B0EB878E}"

31
README.md

@ -0,0 +1,31 @@
# DotSDL
_DotSDL_ is a .NET Standard library designed to allow easy access to the SDL2
library using either the .NET Framework or .NET Core.
Unlike SDL2#, _DotSDL_ is not a direct SDL wrapper. It attempts to add some
additional functionality to make writing SDL applications easier.
### Current Features
At this time, DotSDL supports the following features:
* Audio
* Support for all audio formats supported by SDL.
* Mono output.
* Input
* Keyboard input.
* Window events.
* Graphics
* A single 32-bit ARGB canvas (useful for simple pixel plotting).
### How To Use DotSDL
DotSDL is currently under heavy development and, as such, doesn't have much
in the way of documentation. Currently, the best way to use it is to look over
the sample/test projects and to read over the XMLDocs on the classes and
methods.
If you would still like to play around with DotSDL, the project can be built
using Microsoft Visual Studio 2017. You will also need a SDL2.dll binary for
each architecture that you plan to build your project against.
Loading…
Cancel
Save