[sdlgit/SDL_perl.git] / README

README for SDL_Perl-2.2.1

What's New in 2.2.1:

SDL_Perl-2.2.0 adds support for a few new modules, fixes a few more
bugs, and improves the error handling of the object layer.  Additional
support for SDL_sound, SDL_svg, and SDL_vnc has been added.  In the 
OO layer, all constructors now die when they fail to construct an object
with a valid underlying datastructure pointer.

Prerequisites:

SDL Perl recommends installing the following libraries available
from http://www.libsdl.org/ prior to installing:

	SDL-1.2.8
	smpeg-0.4.5
	SDL_image-1.2.4
	SDL_mixer-1.2.6
	SDL_sound-1.0.1
	SDL_net-1.2.5
	SDL_gfx-2.0.13
	SDL_ttf-2.0.7
	SDL_svg-1.1.9
	SDL_vnc-1.0.0

Additionally the following Perl modules should be installed:

	Module-Build-0.22
	Test-Simple-0.62

Installation:

	perl Build.PL
	./Build
	./Build test
	./Build bundle	# MacOS X only!
	./Build install

Installation with Windows + MinGW:

	set SDL_INST_DIR=Absolute/Path/to/SDLdir
	perl Build.PL
	./Build
	./Build test
	./Build install


The build process will use the new Module::Build facility
to auto detect and build SDL Perl for your platform.  If
the build fails please forward bugs to sdl-devel@perl.org.

For MacOS X users there is a new experimental bundle, 
that is called SDLPerl.app.  You can use this bundle
to run perl scripts with a .spl extension, you know,
SDL Perl files.  We will work on brining this style 
launcher and an integrated development environment to
all platforms shortly.

Documentation:

Each module now includes its own documentation, and 
is accessible through perldoc.  Additional tutorials,
code, and tips can be found at the website:

	http://sdl.perl.org

Online documentation and tutorials are available through
perldoc module.  

Contributing:

Anyone wishing to contribute modules, sprite engines, documentation,
and anything else that others might find useful, please join
the mailing list:

	sdl-devel@perl.org

This is a mailing list for those interested in SDLperl development,
both as an applications developer, and as a core contributor.

I am always more than happy to take patches, bug reports, and
helpful suggestions.  It is feedback, both good and poor, that
keeps projects like this going.

Enjoy,

David J. Goehrig <dgoehrig@cpan.org>
Commit	Line	Data
1e93f803	1	README for SDL_Perl-2.2.1
bfd90409	2
1e93f803	3	What's New in 2.2.1:
bfd90409	4
	5	SDL_Perl-2.2.0 adds support for a few new modules, fixes a few more
	6	bugs, and improves the error handling of the object layer. Additional
	7	support for SDL_sound, SDL_svg, and SDL_vnc has been added. In the
	8	OO layer, all constructors now die when they fail to construct an object
	9	with a valid underlying datastructure pointer.
	10
	11	Prerequisites:
	12
	13	SDL Perl recommends installing the following libraries available
	14	from http://www.libsdl.org/ prior to installing:
	15
	16	SDL-1.2.8
	17	smpeg-0.4.5
	18	SDL_image-1.2.4
	19	SDL_mixer-1.2.6
	20	SDL_sound-1.0.1
	21	SDL_net-1.2.5
	22	SDL_gfx-2.0.13
	23	SDL_ttf-2.0.7
	24	SDL_svg-1.1.9
	25	SDL_vnc-1.0.0
	26
	27	Additionally the following Perl modules should be installed:
	28
	29	Module-Build-0.22
	30	Test-Simple-0.62
	31
	32	Installation:
	33
	34	perl Build.PL
	35	./Build
	36	./Build test
8c726daf	37	./Build bundle # MacOS X only!
bfd90409	38	./Build install
bfd90409	39
1e93f803	40	Installation with Windows + MinGW:
	41
	42	set SDL_INST_DIR=Absolute/Path/to/SDLdir
	43	perl Build.PL
	44	./Build
	45	./Build test
	46	./Build install
	47
	48
bfd90409	49	The build process will use the new Module::Build facility
1e93f803	50	to auto detect and build SDL Perl for your platform. If
bfd90409	51	the build fails please forward bugs to sdl-devel@perl.org.
bfd90409	52
8c726daf	53	For MacOS X users there is a new experimental bundle,
	54	that is called SDLPerl.app. You can use this bundle
	55	to run perl scripts with a .spl extension, you know,
	56	SDL Perl files. We will work on brining this style
	57	launcher and an integrated development environment to
	58	all platforms shortly.
	59
bfd90409	60	Documentation:
	61
	62	Each module now includes its own documentation, and
	63	is accessible through perldoc. Additional tutorials,
	64	code, and tips can be found at the website:
	65
	66	http://sdl.perl.org
	67
	68	Online documentation and tutorials are available through
	69	perldoc module.
	70
	71	Contributing:
	72
	73	Anyone wishing to contribute modules, sprite engines, documentation,
	74	and anything else that others might find useful, please join
	75	the mailing list:
	76
	77	sdl-devel@perl.org
	78
	79	This is a mailing list for those interested in SDLperl development,
	80	both as an applications developer, and as a core contributor.
	81
	82	I am always more than happy to take patches, bug reports, and
	83	helpful suggestions. It is feedback, both good and poor, that
	84	keeps projects like this going.
	85
	86	Enjoy,
	87
	88	David J. Goehrig <dgoehrig@cpan.org>
	89