GitLab Commit is coming up on August 3-4. Learn how to innovate together using GitLab, the DevOps platform. Register for free: gitlabcommitvirtual2021.com

Commit 49b61080 authored by John Croisant's avatar John Croisant
Browse files

Added README and LICENSE.

parent 473b31f0
chicken-sdl2-image: CHICKEN Scheme bindings to SDL_image 2
Copyright © 2015 John Croisant.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
OF THE POSSIBILITY OF SUCH DAMAGE.
# chicken-sdl2-image
[CHICKEN Scheme](http://call-cc.org/) bindings to
[SDL_image](http://www.libsdl.org/projects/SDL_image/) 2.
- Version: 0.1 (in development)
- Project: https://gitlab.com/jcroisant/chicken-sdl2-image
- Issues: https://gitlab.com/jcroisant/chicken-sdl2-image/issues
- License: [BSD 2-Clause](LICENSE-BSD.txt)
- Maintainer: John Croisant (john+chicken at croisant dot net)
## Synopsis
chicken-sdl2-image provides bindings to the SDL_image image loading
library version 2. chicken-sdl2-image is built to be compatible with
[chicken-sdl2](https://gitlab.com/jcroisant/chicken-sdl2), which
provides bindings to Simple DirectMedia Layer (SDL) version 2, a
popular library used in games and other media-rich software.
## Installation
This project is young, so these instructions are still quite sparse.
If you run into trouble installing chicken-sdl2-image, please
[file a support request on the chicken-sdl2 project](https://gitlab.com/jcroisant/chicken-sdl2/blob/master/CONTRIBUTING.md#filing-support-requests) so
we can help you, and so we can improve the install process and
instructions for future users.
### Dependencies
- [chicken-sdl2](https://gitlab.com/jcroisant/chicken-sdl2)
(the `sdl2` egg)
- [SDL_image](http://www.libsdl.org/projects/SDL_image/)
2.0 or higher
chicken-sdl2-image is expected to be compatible with any recent
version of CHICKEN Scheme 4 (e.g. 4.7 or higher). It might also work
with some earlier versions of CHICKEN 4.
### Installing from egg repository
chicken-sdl2-image has not yet been submitted to the egg repository.
For now, you must install from source.
### Installing from source
To install chicken-sdl2-image, clone the repository or download the
source from the project page, then run this command from within the
project's directory (notice these are back ticks, not quotes):
```
SDL2_FLAGS=`sdl2-config --cflags --libs` chicken-install
```
If you do not have the sdl2-config helper program installed on your
computer, you may manually specify SDL-related compiler flags (notice
these are double quotes, not back ticks):
```
SDL2_FLAGS="-I/usr/local/include/SDL2 -L/usr/local/lib -lSDL2" chicken-install
```
By default, chicken-sdl2-image will be linked against SDL_image using
the compiler flag `-lSDL2_image`. You can override this by setting the
`SDL2_IMAGE_FLAGS` environment variable, if needed. You can also use
that environment variable in case you have installed SDL_image in a
different location than SDL.
## Examples
After you have installed chicken-sdl2-image, you can try compiling and
running chicken-sdl2 examples.
The [chicken-sdl2-examples repository](https://gitlab.com/jcroisant/chicken-sdl2-examples)
contains complete example games and programs made with chicken-sdl2
and related libraries.
## Contributing
chicken-sdl2-image is part of the
[chicken-sdl2 project](https://gitlab.com/jcroisant/chicken-sdl2)
chicken-sdl2 is a volunteer effort, and your help is appreciated.
There are many ways to get involved in the project, whether you are an
experienced programmer or not. For more information about how you can
help, please see the chicken-sdl2
[contribution guide](https://gitlab.com/jcroisant/chicken-sdl2/blob/master/CONTRIBUTING.md).
Please be aware that all project participants are expected to abide by
the [Contributor Code of Conduct](https://gitlab.com/jcroisant/chicken-sdl2/blob/master/CODE_OF_CONDUCT.md).
We are committed to making participation in this project a welcoming
and harassment-free experience.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment