diff options
| author | David Thompson <dthompson2@worcester.edu> | 2015-12-20 16:16:29 -0500 |
|---|---|---|
| committer | David Thompson <dthompson2@worcester.edu> | 2015-12-20 16:16:29 -0500 |
| commit | 7365c6c1ab341c8100c72a2e4077b132a742939a (patch) | |
| tree | faafa513317d1036432cb0f6f64f8017daa20b51 /README | |
| parent | db3dea0c6ab3a2a8407035b44a1aaa4e8cdbdd86 (diff) | |
Update README.
Diffstat (limited to 'README')
| -rw-r--r-- | README | 23 |
1 files changed, 21 insertions, 2 deletions
@@ -1,15 +1,18 @@ -*- mode: org -*- -Guile-sdl2 provides Guile Scheme bindings for the SDL2 C shared +Guile-SDL2 provides Guile Scheme bindings for the SDL2 C shared library. The bindings are written in pure Scheme by using Guile's foreign function interface. * Requirements - Guile-sdl2 currently depends on the following packages: + Guile-SDL2 currently depends on the following packages: - GNU Guile >= 2.0.9 - SDL2 >= 2.0.0 + - SDL2_image >= 2.0.0 + - SDL2_mixer >= 2.0.0 + - SDL2_ttf >= 2.0.0 - GNU Make - GNU pkg-config @@ -38,6 +41,22 @@ foreign function interface. # guix package -f guix.scm +* Usage + + Guile-SDL2 provides modules in the '(sdl2 ...)' namespace, roughly + organized how the SDL2 C header files are organized. See the + =examples= directory for practical examples. + + Low-level bindings are available in the '(sdl2 bindings ...)' + namespace, but these are not recommended for normal usage. + + Additionally, SDL2 extension library bindings are available in the + following modules: + + - SDL2_image: (sdl2 image) + - SDL2_mixer: (sdl2 mixer) + - SDL2_ttf: (sdl2 ttf) + * Developing To build the source code from a Git checkout, run the following: |