Skip to content

Commit 715eef8

Browse files
soupiocharles
authored andcommitted
Adding a link to the getting started guide at the SDL module (#182)
1 parent 647c561 commit 715eef8

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
This package provides Haskell bindings for the SDL2 library.
2+
3+
# What is SDL2?
4+
5+
SDL (Simple DirectMedia Layer) is a library for cross-platform development of interactive applications.
6+
SDL provides routines for managing windows, rendering graphics, processing sound, collecting input data, and much more.
7+
8+
The Haskell sdl2 library provides both a high- and low-level API to interface with SDL.
9+
10+
You may also want to check out:
11+
12+
- [sdl2-image](https://hackage.haskell.org/package/sdl2-image) - For handling different image formats such as `jpg` and `png`.
13+
- [sdl2-mixer](https://hackage.haskell.org/package/sdl2-mixer) - For playing audio.
14+
- [sdl2-gfx](https://hackage.haskell.org/package/sdl2-gfx) - For drawing graphics primitives such as circles and polygons.
15+
- [sdl2-ttf](https://hackage.haskell.org/package/sdl2-ttf) - For handling true type fonts.
16+
17+
118
# Building
219

320
[![Build Status](https://travis-ci.org/haskell-game/sdl2.svg?branch=master)](https://travis-ci.org/haskell-game/sdl2)
@@ -18,6 +35,10 @@ On Windows you can install SDL with `pacman` under [MSYS2](https://msys2.github.
1835

1936
pacman -S mingw-w64-x86_64-pkg-config mingw-w64-x86_64-SDL2
2037

38+
# Get Started
39+
40+
Take a look at the [getting started guide](https://hackage.haskell.org/package/sdl2/docs/SDL.html).
41+
2142
# Contributing
2243

2344
We need your help! The SDL API is fairly large, and the more hands we have, the

sdl2.cabal

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ description:
1212
Haskell FFI calls. As such, this does not contain sum types nor error
1313
checking. Thus this namespace is suitable for building your own abstraction
1414
over SDL, but is not recommended for day-to-day programming.
15+
.
16+
Read "SDL" for a getting started guide.
1517

1618
license: BSD3
1719
license-file: LICENSE

0 commit comments

Comments
 (0)