threads::shared 1.24 (phase 2)

[p5sagit/p5-mst-13.2.git] / ext / Devel / PPPort / README

diff --git a/ext/Devel/PPPort/README b/ext/Devel/PPPort/README
index dc8cb2f..42def29 100644 (file)
--- a/ext/Devel/PPPort/README
+++ b/ext/Devel/PPPort/README
@@ -1,14 +1,78 @@
 
- Perl/Pollution/Portability Version 1.0005
+        ------------------------------------------------------
+         Devel::PPPort - Perl/Pollution/Portability Version 3
+        ------------------------------------------------------
 
- Copyright (C) 2001, Paul Marquess. 
- Copyright (C) 1999, Kenneth Albanowski. 
- This archive may be used and distributed under the same license as any
- version of Perl.
+CONTENTS
 
-This module is used to create a 'C' header file that can be used by XS
-authors. It allows XS module authors to use the latest version of the
-Perl API, but still allow their module to be built with older versions
-of Perl.
+1. DESCRIPTION
+2. INSTALLATION
+3. DOCUMENTATION
+4. BUGS
+5. COPYRIGHT
+
+
+--------------
+1. DESCRIPTION
+--------------
+
+Perl's API has changed over time, gaining new features, new functions,
+increasing its flexibility, and reducing the impact on the C namespace
+environment (reduced pollution). The header file written by this module,
+typically F<ppport.h>, attempts to bring some of the newer Perl API
+features to older versions of Perl, so that you can worry less about
+keeping track of old releases, but users can still reap the benefit.
+
+---------------
+2. INSTALLATION
+---------------
+
+Installation of the Devel::PPPort module follows the standard Perl Way
+and should not be harder than:
+
+  perl Makefile.PL
+  make
+  make test
+  make install
+
+Note that you may need to become superuser to 'make install'.
+
+If you're building the module under Windows, you may need to use a
+different make program, such as 'nmake', instead of 'make'.
+
+----------------
+3. DOCUMENTATION
+----------------
+
+To see the documentation, use the perldoc command:
+
+  perldoc Devel::PPPort
+
+You can also visit CPAN Search and see the documentation online as
+pretty nice HTML. This is also where you will find the most recent
+version of this module:
+
+  http://search.cpan.org/~mhx/Devel-PPPort/
+
+-------
+4. BUGS
+-------
+
+If you find any bugs, Devel::PPPort doesn't seem to build on your
+system or any of its tests fail, please use the CPAN Request Tracker
+
+  http://rt.cpan.org/
+
+to create a ticket for the module.
+
+------------
+5. COPYRIGHT
+------------
+
+Version 3.x, Copyright (C) 2004-2008, Marcus Holland-Moritz.
+Version 2.x, Copyright (C) 2001, Paul Marquess.
+Version 1.x, Copyright (C) 1999, Kenneth Albanowski.
+
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
 
-For more details see PPPort.pm.