diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..e1dddef --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# Guile-SDL3 + +Guile-SDL3 provides Guile Scheme bindings for the SDL3 library. + +## Requirements + +- Guile >= 3.0 +- SDL3 >= 3.0.0 +- make +- pkg-config + +When building from a Git checkout, the following additional packages +are required: + +- autoconf +- automake +- texinfo + +If you use Guix, a build environment can be created by running `guix +shell`. + +## Building + +### From release tarball + +``` +./configure +make +make install +``` + +### From Git checkout + +``` +./bootstrap +./configure +make +make install +``` + +## Contributing + +In lieu of a proper issue tracker, send patches and bug reports to +<dthompson2@worcester.edu>. Discussion can be had on the #guile +channel on the Libera.Chat IRC network or on the guile-user mailing +lis. |