summaryrefslogtreecommitdiff
path: root/cpan/Pod-Simple/README
diff options
context:
space:
mode:
Diffstat (limited to 'cpan/Pod-Simple/README')
-rw-r--r--cpan/Pod-Simple/README64
1 files changed, 59 insertions, 5 deletions
diff --git a/cpan/Pod-Simple/README b/cpan/Pod-Simple/README
index 3be9a63a6c..00f0c12cc3 100644
--- a/cpan/Pod-Simple/README
+++ b/cpan/Pod-Simple/README
@@ -1,7 +1,61 @@
- Time-stamp: "2003-09-01 23:10:23 ADT"
+=head1 Pod::Simple version 3.11
-This is a late-beta release of Pod::Simple, the module-suite for
-parsing Pod.
+Pod::Simple is a Perl library for parsing text in the Pod ("plain old
+documentation") markup language that is typically used for writing
+documentation for Perl and for Perl modules. The Pod format is explained
+L<perlpod>; the most common formatter is called C<perldoc>.
-There are still some gaps in the documentation, and Pod::Simple::HTML
-isn't yet all that it should be.
+Pod formatters can use Pod::Simple to parse Pod documents and render them into
+plain text, HTML, or any number of other formats.
+
+=head2 Installation
+
+To install this module, type the following:
+
+ perl Makefile.PL
+ make
+ make test
+ make install
+
+=head2 Support
+
+Questions or discussion about POD and Pod::Simple should be sent to the
+pod-people@perl.org mail list. Send an empty email to
+pod-people-subscribe@perl.org to subscribe.
+
+This module is managed in an open GitHub repository,
+L<http://github.com/theory/pod-simple/>. Feel free to fork and contribute, or
+to clone L<git://github.com/theory/pod-simple.git> and send patches!
+
+Patches against Pod::Simple are welcome. Please send bug reports to
+<bug-pod-simple@rt.cpan.org>.
+
+=head1 copyright and Disclaimers
+
+Copyright (c) 2002 Sean M. Burke. All rights reserved.
+
+This library is free software; you can redistribute it and/or modify it
+under the same terms as Perl itself.
+
+This program is distributed in the hope that it will be useful, but
+without any warranty; without even the implied warranty of
+merchantability or fitness for a particular purpose.
+
+=head1 Author
+
+Pod::Simple was created by Sean M. Burke <sburke@cpan.org>.
+But don't bother him, he's retired.
+
+Pod::Simple is maintained by:
+
+=over
+
+=item * Allison Randal C<allison@perl.org>
+
+=item * Hans Dieter Pearcey C<hdp@cpan.org>
+
+=item * David E. Wheeler C<dwheeler@cpan.org>
+
+=back
+
+=cut