Commits

Toby Inkster committed 9460b1b

docs

Comments (0)

Files changed (2)

lib/Module/Install/Admin/Copyright.pm

 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+Module::Install::Admin::Copyright - author-side part of Module::Install::Copyright
+
+=head1 DESCRIPTION
+
+Not really documented much right now..
+
+=head1 BUGS
+
+Please report any bugs to
+L<http://rt.cpan.org/Dist/Display.html?Queue=Module-Install-Copyright>.
+
+=head1 SEE ALSO
+
+L<Module::Install::Copyright>.
+
+=head1 AUTHOR
+
+Toby Inkster E<lt>tobyink@cpan.orgE<gt>.
+
+=head1 COPYRIGHT AND LICENCE
+
+This software is copyright (c) 2012 by Toby Inkster.
+
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.
+
+=head1 DISCLAIMER OF WARRANTIES
+
+THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
+MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+

lib/Module/Install/Copyright.pm

 package Module::Install::Copyright;
 
-use 5.008;
+use 5.006;
 use base qw(Module::Install::Base);
 use strict;
 
 
 =head1 SYNOPSIS
 
+In Makefile.PL:
+
+	write_copyright_file;
+
 =head1 DESCRIPTION
 
+Extracts copyright and licensing information from embedded pod and/or RDF
+metadata included in the distribution, and outputs it as a text file called
+"COPYRIGHT" which should roughly conform to the Debian copyright file format.
+
 =head1 BUGS
 
 Please report any bugs to
 
 =head1 SEE ALSO
 
+This is a plugin for L<Module::Install>.
+
+It relies on metadata from L<Module::Install::RDF>.
+
+It outputs data roughly conforming to
+L<http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/>.
+
 =head1 AUTHOR
 
 Toby Inkster E<lt>tobyink@cpan.orgE<gt>.
 This is free software; you can redistribute it and/or modify it under
 the same terms as the Perl 5 programming language system itself.
 
-
 =head1 DISCLAIMER OF WARRANTIES
 
 THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED