Read Me

Schwarzer Kaffe(sk) --  A SDL wrapper for the GNU-Modula-2 compiler *
*********************************************************************
by Martin Kalbfuß


INSTALL
---------------------------------------------------------------------
You can find the installation instructions in the INSTALL file.


LICENCE
---------------------------------------------------------------------
It's licensed under LGPL. For more details have a look at COPYING.


CONTACT AND BUG REPORTS
---------------------------------------------------------------------
For questions, ideas and bug reports use the following mailing lists.
Please report misspellings, too. I'm not a native speaker.

schwarzerkaffee-help
schwarzerkaffee-discuss
schwarzerkaffee-bugs

To subscribe visit the project page at:

https://sourceforge.net/projects/schwarzerkaffee/


USAGE
---------------------------------------------------------------------
Currently there's no API documentation. This will change for later
versions. Have a look at the definition modules and the SDL
documentation.

The function names are the same but without the SDL prefix. Instead
the functionality is split up in sections, following the SDL
documentation. The modules naming scheme is the section name prefixed
with SK. For example SKVideo. There is a small example in the example
directory. It's good enough as starting point. There's no need to
initialize SDL or any of the modules. This is done automatically upon
module import.

If a function fails, an exception is raised with SDL_Error as message.
If not catched, you get a default error message. This should be enough
for most cases. This means the SK function equivalents do not return
any error values.


INTENTION
---------------------------------------------------------------------
SDL is written in C, a flexible and fast but unsave and weird
language. This wrapper tries to improve the programming experience
with SDL by using a language designed with savetiness and cleanliness
in mind. This is true for Wirth's languages like Modula-2. Hopefully
this will lead to better, cleaner and saver code.


DEVELOPMENT
---------------------------------------------------------------------
Currently Schwarzer Kaffee isn't very useful. But if you like this
project please help by using it and reporting bugs and problems. Your
ideas about improvements and additions are welcome. Currently there's
no documentation.

If you're good at writing info pages, please help. I never done this
before. More examples are needed, too. Any ideas? Let me know.

If you'd like to contribute, mail me at ma.kalbfuss@web.de