Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added README.pod

  • Loading branch information...
commit a236485e01d3e6237b8436d4ec66658862ccf042 1 parent 17bd07f
@dann authored
Showing with 74 additions and 69 deletions.
  1. +3 −3 Makefile.PL
  2. +0 −66 README.mkdn
  3. +71 −0 README.pod
View
6 Makefile.PL
@@ -1,6 +1,6 @@
-sub readme_markdown_from {
+sub readme_pod_from {
warn
- "You need to install Module::Install::ReadmeMarkdownFromPod to generate README";
+ "You need to install Module::Install::ReadmePodFromPod to generate README.pod";
}
sub author_requires {
@@ -15,7 +15,7 @@ use inc::Module::Install;
name 'Perl-Metrics-Lite';
perl_version '5.005';
all_from 'lib/Perl/Metrics/Lite.pm';
-readme_markdown_from 'lib/Perl/Metrics/Lite.pm';
+readme_pod_from 'lib/Perl/Metrics/Lite.pm';
requires(
'Carp' => 0,
View
66 README.mkdn
@@ -1,66 +0,0 @@
-# NAME
-
-Perl::Metrics::Lite - Pluggable Perl Code Metrics System
-
-# SYNOPSIS
-
- use Perl::Metrics::Lite;
- my $analzyer = Perl::Metrics::Lite->new;
- my $analysis = $analzyer->analyze_files(@ARGV);
- my $file_stats = $analysis->file_stats;
- my $sub_stats = $analysis->sub_stats;
-
-# DESCRIPTION
-
-__Perl::Metrics::Lite__ is the pluggable perl code metrics system.
-
-__Perl::Metrics::Lite__ provides just enough methods to run static analysis
-of one or many Perl files and obtain a few metrics.
-
-__Perl::Metrics::Lite__ is far simpler than [Perl::Metrics](http://search.cpan.org/perldoc?Perl::Metrics)
-and more extensible than [Perl::Metrics::Simple](http://search.cpan.org/perldoc?Perl::Metrics::Simple).
-
-# USAGE
-
-See the `measureperl` and `measureperl-checkstyle` script
-(included with this distribution) for a simple example of usage.
-
-# CLASS METHODS
-
-## new
-
-Takes no arguments and returns a new [Perl::Metrics::Lite](http://search.cpan.org/perldoc?Perl::Metrics::Lite) object.
-
-# OBJECT METHODS
-
-## analyze_files( @paths, @refs_to_file_contents )
-
-Takes an array of files and or directory paths, and/or
-SCALAR refs to file contents and returns
-an [Perl::Metrics::Lite::Analysis](http://search.cpan.org/perldoc?Perl::Metrics::Lite::Analysis) object.
-
-# SOURCE AVAILABILITY
-
-This source is in Github:
-
- http://github.com/dann/p5-perl-metrics-lite
-
-# CONTRIBUTORS
-
-Many thanks to:
-
-
-
-# AUTHOR
-
-Dann <techmemo{at}gmail.com>
-
-# SEE ALSO
-
-[Perl::Metrics](http://search.cpan.org/perldoc?Perl::Metrics)
-[Perl::Metrics::Simple](http://search.cpan.org/perldoc?Perl::Metrics::Simple)
-
-# LICENSE
-
-This library is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself.
View
71 README.pod
@@ -0,0 +1,71 @@
+=encoding utf-8
+
+=head1 NAME
+
+Perl::Metrics::Lite - Pluggable Perl Code Metrics System
+
+=head1 SYNOPSIS
+
+ use Perl::Metrics::Lite;
+ my $analzyer = Perl::Metrics::Lite->new;
+ my $analysis = $analzyer->analyze_files(@ARGV);
+ my $file_stats = $analysis->file_stats;
+ my $sub_stats = $analysis->sub_stats;
+
+=head1 DESCRIPTION
+
+B<Perl::Metrics::Lite> is the pluggable perl code metrics system.
+
+B<Perl::Metrics::Lite> provides just enough methods to run static analysis
+of one or many Perl files and obtain a few metrics.
+
+B<Perl::Metrics::Lite> is far simpler than L<Perl::Metrics>
+and more extensible than L<Perl::Metrics::Simple>.
+
+=head1 USAGE
+
+See the F<measureperl> and F<measureperl-checkstyle> script
+(included with this distribution) for a simple example of usage.
+
+=head1 CLASS METHODS
+
+=head2 new
+
+Takes no arguments and returns a new L<Perl::Metrics::Lite> object.
+
+=head1 OBJECT METHODS
+
+=head2 analyze_files( @paths, @refs_to_file_contents )
+
+Takes an array of files and or directory paths, and/or
+SCALAR refs to file contents and returns
+an L<Perl::Metrics::Lite::Analysis> object.
+
+=head1 SOURCE AVAILABILITY
+
+This source is in Github:
+
+ http://github.com/dann/p5-perl-metrics-lite
+
+=head1 CONTRIBUTORS
+
+Many thanks to:
+
+
+=head1 AUTHOR
+
+Dann E<lt>techmemo{at}gmail.comE<gt>
+
+=head1 SEE ALSO
+
+L<Perl::Metrics>
+L<Perl::Metrics::Simple>
+
+=head1 LICENSE
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+
+=cut
+
Please sign in to comment.
Something went wrong with that request. Please try again.