Permalink
Browse files

updated changelog, readme, set version to 0.1

  • Loading branch information...
1 parent face822 commit 4f50029509634e5c4d4262ae1a354e4e858787b5 Tobias Leich committed Apr 18, 2010
Showing with 92 additions and 181 deletions.
  1. +4 −0 CHANGELOG
  2. +0 −67 Changes
  3. +81 −98 README
  4. +1 −10 TODO
  5. +6 −6 lib/Alien/PNG.pm
View
@@ -0,0 +1,4 @@
+Revision history for Perl module Alien::PNG
+
+0.1 Sun Apr 18 2010
+ - initial release [FROGGS]
View
67 Changes
@@ -1,67 +0,0 @@
-Revision history for Perl module Alien::SDL
-
-1.3 Thu Apr 15 2010
- - additional libs can be specyfied via Alien::SDL->config('libs', [-lAdd_Lib]) [FROGGS]
-
-1.2
- - build_requires fixed (now contains also modules needed for ./Build test)
- - Win32 patch - proper handling of spaces in dirname [FROGGS]
- - Better detection of patch utility (now works with old patch on bsd systems) [kmx]
- - GNU make autodetection (on bsd systems make!=GNU-make) [kmx]
- - SDL_Pango special patch now defines SDL_PANGO_FB [kthakore]
- - more diagnostics in t/001_load.t
- - improved patching mechanism (better CRLF/LF handling) [FROGGS]
- - Win/32bit binaries (with SDL_Pango patch) [FROGGS]
- - MacOSx file find bug fixed
-
-1.1
- - Powerpc fixes [ioanrogers]
- - fix for many failing MacOS CPAN tester reports [kmx]
- - updated packages (zlib-1.2.4, jpeg-8a, libpng-1.4.1, freetype-2.3.12) in src build [kmx]
- - new Win32 binaries by FROGGS (now works well on WinXP & Win7)
- - typo fixes [dorkfish]
-
-1.0
- - TODO for 1.0 release has been met so incrementing
-
-0.9.1
- - extended Windows/32bit binaries made a default option
- - additional src build set added (no preinstalled jpeg, freetype2, png required)
- - cygwin related patches [http://rt.cpan.org/Ticket/Display.html?id=55202]
-
-0.9
- - An updated windows pack [kmx]
- - Dependencies of SHA fixed [kmx]
-
-0.8.2
- - Local sharedir building [kmx, FROGGS]
- - 64bit building [kthakore, kmx]
- - Darwin testing [Mike Stok, Stuart Watt, Chas Owens] and fixing [kthakore, kmx]
- - Dependencies fixes [kmx]
-
-
-0.8.1
- - Quick fix for follow_skip in File::Find, and test numbers
-
-0.8.0
- - Complete redesign by kmx, completely new interface
- - Fixed Bug on File::Find usage to get headers
-0.7.8
- - Get and compile latest code for SDL, gfx, image, mixer, ttf and net
-
-0.7.6
- - check if make failed or passed
-
-0.06.1 Sat Sept 14 2009
- - Fixed a stupid mistake
-0.06 Fri Sept 18 2009
- - Added File::Fetch to inc
- - Added File::Spec::Unix to inc
- - Added IPC::cmd to inc
- - Added Archive::Extract to inc
-
-0.02 Fri Aug 7 2009
- - Updated perlDoc
-
-0.01 Thu Aug 6 2009
- - original version; created by ExtUtils::ModuleMaker 0.51
View
179 README
@@ -1,142 +1,125 @@
-NAME
- Alien::SDL - building, finding and using SDL binaries
+Alien::PNG - building, finding and using PNG binaries
-VERSION
- Version 1.2
+Version 0.1
SYNOPSIS
- Alien::SDL tries (in given order) during its installation:
+ Alien::PNG tries (in given order) during its installation:
- * Locate an already installed SDL via 'sdl-config' script.
+ * Locate an already installed PNG via 'libpng-config' script.
- * Check for SDL libs in directory specified by SDL_INST_DIR variable.
- In this case the module performs SDL library detection via
- '$SDL_INST_DIR/bin/sdl-config' script.
+ * Check for PNG libs in directory specified by PNG_INST_DIR variable.
+ In this case the module performs PNG library detection via
+ '$PNG_INST_DIR/bin/libpng-config' script.
- * Download prebuilt SDL binaries (if available for your platform).
+ * Download prebuilt PNG binaries (if available for your platform).
- * Build SDL binaries from source codes (if possible on your system).
+ * Build PNG binaries from source codes (if possible on your system).
- Later you can use Alien::SDL in your module that needs to link agains
- SDL and/or related libraries like this:
+ Later you can use Alien::PNG in your module that needs to link agains PNG
+ and/or related libraries like this:
- # Sample Makefile.pl
- use ExtUtils::MakeMaker;
- use Alien::SDL;
+ # Sample Makefile.pl
+ use ExtUtils::MakeMaker;
+ use Alien::PNG;
- WriteMakefile(
- NAME => 'Any::SDL::Module',
- VERSION_FROM => 'lib/Any/SDL/Module.pm',
- LIBS => Alien::SDL->config('libs'),
- INC => Alien::SDL->config('cflags'),
- # + additional params
- );
+ WriteMakefile(
+ NAME => 'Any::PNG::Module',
+ VERSION_FROM => 'lib/Any/PNG/Module.pm',
+ LIBS => Alien::PNG->config('libs', [-lAdd_Lib]),
+ INC => Alien::PNG->config('cflags'),
+ # + additional params
+ );
DESCRIPTION
- Please see Alien for the manifesto of the Alien namespace.
+ Please see L<Alien> for the manifest of the Alien namespace.
- In short "Alien::SDL" can be used to detect and get configuration
- settings from an installed SDL and related libraries. Based on your
- platform it offers the possibility to download and install prebuilt
- binaries or to build SDL & co. from source codes.
+ In short C<Alien::PNG> can be used to detect and get
+ configuration settings from an installed PNG and related libraries.
+ Based on your platform it offers the possibility to download and
+ install prebuilt binaries or to build PNG & co. from source codes.
- The important facts:
+The important facts:
+ * The module does not modify in any way the already existing PNG
+ installation on your system.
- * The module does not modify in any way the already existing SDL
- installation on your system.
+ * If you reinstall PNG libs on your system you do not need to
+ reinstall Alien::PNG (providing that you use the same directory for
+ the new installation).
- * If you reinstall SDL libs on your system you do not need to
- reinstall Alien::SDL (providing that you use the same directory for
- the new installation).
+ * The prebuild binaries and/or binaries built from sources are always
+ installed into perl module's 'share' directory.
- * The prebuild binaries and/or binaries built from sources are always
- installed into perl module's 'share' directory.
+ * If you use prebuild binaries and/or binaries built from sources
+ it happens that some of the dynamic libraries (*.so, *.dll) will not
+ automaticly loadable as they will be stored somewhere under perl module's
+ 'share' directory. To handle this scenario Alien::PNG offers some special
+ functionality (see below).
- * If you use prebuild binaries and/or binaries built from sources it
- happens that some of the dynamic libraries (*.so, *.dll) will not
- automaticly loadable as they will be stored somewhere under perl
- module's 'share' directory. To handle this scenario Alien::SDL
- offers some special functionality (see below).
METHODS
- config()
- This function is the main public interface to this module. Basic
- functionality works in a very similar maner to 'sdl-config' script:
+ config()
+ This function is the main public interface to this module. Basic
+ functionality works in a very similar maner to 'libpng-config' script:
- Alien::SDL->config('prefix'); # gives the same string as 'sdl-config --prefix'
- Alien::SDL->config('version'); # gives the same string as 'sdl-config --version'
- Alien::SDL->config('libs'); # gives the same string as 'sdl-config --libs'
- Alien::SDL->config('cflags'); # gives the same string as 'sdl-config --cflags'
+ Alien::PNG->config('prefix'); # gives the same string as 'libpng-config --prefix'
+ Alien::PNG->config('version'); # gives the same string as 'libpng-config --version'
+ Alien::PNG->config('libs'); # gives the same string as 'libpng-config --libs'
+ Alien::PNG->config('cflags'); # gives the same string as 'libpng-config --cflags'
- On top of that this function supports special parameters:
+ On top of that this function supports special parameters:
- Alien::SDL->config('ld_shared_libs');
+ Alien::PNG->config('ld_shared_libs');
- Returns a list of full paths to shared libraries (*.so, *.dll) that will
- be required for running the resulting binaries you have linked with SDL
- libs.
+ Returns a list of full paths to shared libraries (*.so, *.dll) that will be
+ required for running the resulting binaries you have linked with PNG libs.
- Alien::SDL->config('ld_paths');
+ Alien::PNG->config('ld_paths');
- Returns a list of full paths to directories with shared libraries (*.so,
- *.dll) that will be required for running the resulting binaries you have
- linked with SDL libs.
+ Returns a list of full paths to directories with shared libraries (*.so, *.dll)
+ that will be required for running the resulting binaries you have linked with
+ PNG libs.
- Alien::SDL->config('ld_shlib_map');
+ Alien::PNG->config('ld_shlib_map');
- Returns a reference to hash of value pairs '<libnick>' =>
- '<full_path_to_shlib'>, where '<libnick>' is shortname for SDL related
- library like: SDL, SDL_gfx, SDL_net, SDL_sound ... + some non-SDL
- shortnames e.g. smpeg, jpeg, png.
+ Returns a reference to hash of value pairs '<libnick>' => '<full_path_to_shlib'>,
+ where '<libnick>' is shortname for PNG related library like: PNG.
- NOTE: config('ld_<something>') return an empty list/hash if you have
- decided to use SDL libraries already installed on your system. This
- concerns 'sdl-config' detection and detection via
- '$SDL_INST_DIR/bin/sdl-config'.
+ NOTE: config('ld_<something>') return an empty list/hash if you have decided to
+ use PNG libraries already installed on your system. This concerns 'libpng-config'
+ detection and detection via '$PNG_INST_DIR/bin/libpng-config'.
- check_header()
- This function checks the availability of given header(s) when using
- compiler options provided by "Alien::SDL->config('cflags')".
+ check_header()
+ This function checks the availability of given header(s) when using compiler
+ options provided by "Alien::PNG->config('cflags')".
- Alien::SDL->check_header('SDL.h');
- Alien::SDL->check_header('SDL.h', 'SDL_net.h');
+ Alien::PNG->check_header('png.h');
+ Alien::PNG->check_header('png.h', 'pngconf.h');
- Returns 1 if all given headers are available, 0 otherwise.
+ Returns 1 if all given headers are available, 0 otherwise.
- get_header_version()
- Tries to find a header file specified as a param in SDL prefix direcotry
- and based on "#define" macros inside this header file tries to get a
- version triplet.
+ get_header_version()
+ Tries to find a header file specified as a param in PNG prefix direcotry and
+ based on "#define" macros inside this header file tries to get a version triplet.
- Alien::SDL->get_header_version('SDL_mixer.h');
- Alien::SDL->get_header_version('SDL_version.h');
- Alien::SDL->get_header_version('SDL_gfxPrimitives.h');
- Alien::SDL->get_header_version('SDL_image.h');
- Alien::SDL->get_header_version('SDL_mixer.h');
- Alien::SDL->get_header_version('SDL_net.h');
- Alien::SDL->get_header_version('SDL_ttf.h');
- Alien::SDL->get_header_version('smpeg.h');
+ Alien::PNG->get_header_version('png.h');
- Returns string like '1.2.3' or undef if not able to find and parse
- version info.
+ Returns string like '1.2.3' or undef if not able to find and parse version info.
BUGS
- Please post issues and bugs at
- <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Alien-SDL>
+ Please post issues and bugs at L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Alien-PNG>
AUTHOR
- Kartik Thakore
- CPAN ID: KTHAKORE
- Thakore.Kartik@gmail.com
- http://yapgh.blogspot.com
+ Tobias Leich
+ CPAN ID: FROGGS
+ FROGGS@cpan.org
ACKNOWLEDGEMENTS
- kmx - complete redesign between versions 0.7.x and 0.8.x
+ This module is based on Alien::SDL, so in fact the credits has to be given to these guys.
+ kmx - complete redesign between versions 0.7.x and 0.8.x of the Alien::SDL module
COPYRIGHT
- This program is free software; you can redistribute it and/or modify it
- under the same terms as Perl itself.
-
- The full text of the license can be found in the LICENSE file included
- with this module.
+ This program is free software; you can redistribute
+ it and/or modify it under the same terms as Perl itself.
+ The full text of the license can be found in the
+ LICENSE file included with this module.
View
11 TODO
@@ -1,11 +1,2 @@
-TODO list for Perl module Alien::SDL
+TODO list for Perl module Alien::PNG
-- discuss automated CPAN Testers issues (and perhaps change build defaults somehow)
-- think of a complex t\alien_sdl_interface.t (we need this more in SDL_perl)
-- move prebuilt binaries to http://sdl.perl.org/
-- switch src builds to SDL_ttf-2.0.10.tar.gz (not released yet)
- unofficial version: http://www.libsdl.org/tmp/SDL_ttf/release/SDL_ttf-2.0.10.tar.gz
-- give option to use old sources
-- give app to update and manage source code see below
-- use a json file which we can update off site (not hard coded) to link to new SHA sum and packs
-- build new Win/64bit binaries with SDL_Pango patch
View
@@ -15,7 +15,7 @@ Alien::PNG - building, finding and using PNG binaries
=head1 VERSION
-Version 0.1_0
+Version 0.1
=cut
@@ -57,7 +57,7 @@ and/or related libraries like this:
=head1 DESCRIPTION
-Please see L<Alien> for the manifesto of the Alien namespace.
+Please see L<Alien> for the manifest of the Alien namespace.
In short C<Alien::PNG> can be used to detect and get
configuration settings from an installed PNG and related libraries.
@@ -145,13 +145,13 @@ Please post issues and bugs at L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Alien-
=head1 AUTHOR
- Kartik Thakore
- CPAN ID: KTHAKORE
- Thakore.Kartik@gmail.com
- http://yapgh.blogspot.com
+ Tobias Leich
+ CPAN ID: FROGGS
+ FROGGS@cpan.org
=head1 ACKNOWLEDGEMENTS
+ This module is based on Alien::SDL, so in fact the credits has to be given to these guys.
kmx - complete redesign between versions 0.7.x and 0.8.x
=head1 COPYRIGHT

0 comments on commit 4f50029

Please sign in to comment.