[tapx-dev] [commit][267] Made Build/Makefile messages more descriptive, README less generic.

[andy at hexten.net]

Revision: 267
Author:   andy
Date:     2007-08-18 20:18:07 +0100 (Sat, 18 Aug 2007)

Log Message:
-----------
Made Build/Makefile messages more descriptive, README less generic.

Modified Paths:
--------------
    trunk/Build.PL
    trunk/Makefile.PL
    trunk/README

Modified: trunk/Build.PL
===================================================================
--- trunk/Build.PL	2007-08-18 18:58:32 UTC (rev 266)
+++ trunk/Build.PL	2007-08-18 19:18:07 UTC (rev 267)
@@ -5,7 +5,7 @@
 # NOTE: make this actually be inc/MyBuilder.pm if it gets any bigger
 my $build_class = Module::Build->subclass(
     class => 'inc::MyBuilder',
-    code => <<'    SUBCLASS',
+    code  => <<'    SUBCLASS',
       sub ACTION_testruntests {
           my $self = shift;
           $self->depends_on('code');
@@ -15,18 +15,18 @@
 );
 
 my $builder = $build_class->new(
-    module_name          => 'TAP::Parser',
-    license              => 'perl',
-    meta_merge           => {
+    module_name => 'TAP::Parser',
+    license     => 'perl',
+    meta_merge  => {
         resources => {
             homepage => 'http://testanything.org/',
             bugtracker =>
-                'http://rt.cpan.org/Public/Dist/Display.html?Name=TAP-Parser',
+              'http://rt.cpan.org/Public/Dist/Display.html?Name=TAP-Parser',
             MailingList => 'mailto:<tapx-dev at hexten.net>',
             repository =>
-                'http://svn.hexten.net/tapx/trunk',
-         },
-         keywords => ['TAP', 'test harness', 'prove', 'runtests'],
+              'http://svn.hexten.net/tapx/trunk',
+        },
+        keywords => [ 'TAP', 'test harness', 'prove', 'runtests' ],
     },
     recursive_test_files => 1,
     requires             => {
@@ -36,8 +36,14 @@
     add_to_cleanup => ['TAP-Parser-*'],
 );
 
-if ( $builder->prompt( "Do you wish to install the 'runtests' utility?", "y" )
-    =~ /^[Yy]/ )
+if ($builder->prompt(
+        "TAP::Parser includes \"runtests\" which is the equivalent of the\n"
+          . "TAP::Harness \"prove\". If you choose to install runtests you will be able\n"
+          . "to run a module's test suite via TAP::Parser by typing \"runtests -rb\" in\n"
+          . "the project's root directory.\n\n" 
+          . "Do you wish to install the 'runtests' utility?", "y"
+    ) =~ /^[Yy]/
+  )
 {
     $builder->script_files( ["bin/runtests"] );
 }

Modified: trunk/Makefile.PL
===================================================================
--- trunk/Makefile.PL	2007-08-18 18:58:32 UTC (rev 266)
+++ trunk/Makefile.PL	2007-08-18 19:18:07 UTC (rev 267)
@@ -3,11 +3,22 @@
 use strict;
 
 eval 'use ExtUtils::MakeMaker::Coverage';
-warn "Optional ExtUtils::MakeMaker::Coverage not available\n" if $@;
+warn
+  "\nOptional ExtUtils::MakeMaker::Coverage not available. Everything should\n",
+  "still work correctly but you won't be able to run the coverage tests by\n",
+  "typing \"make testcover\". If you subsequently install Devel::Cover please\n",
+  "re-run \"perl Makefile.PL\" to include the testcover target.\n\n"
+  if $@;
 
 my @program;
-if (
-    prompt( "Do you wish to install the 'runtests' utility?", "y" ) =~ /^[Yy]/ )
+if (prompt(
+        "TAP::Parser includes \"runtests\" which is the equivalent of the\n"
+          . "TAP::Harness \"prove\". If you choose to install runtests you will be able\n"
+          . "to run a module's test suite via TAP::Parser by typing \"runtests -rb\" in\n"
+          . "the project's root directory.\n\n"
+          . "Do you wish to install the 'runtests' utility?", "y"
+    ) =~ /^[Yy]/
+  )
 {
     @program = ( EXE_FILES => ["bin/runtests"] );
 }

Modified: trunk/README
===================================================================
--- trunk/README	2007-08-18 18:58:32 UTC (rev 266)
+++ trunk/README	2007-08-18 19:18:07 UTC (rev 267)
@@ -1,26 +1,32 @@
 TAP-Parser 0.53
 
-The README is used to introduce the module and provide instructions on
-how to install the module, any machine dependencies it may have (for
-example C compilers and installed libraries) and any other information
-that should be provided before the module is installed.
+TAP::Parser is designed as a replacement for Test::Harness. It is hoped
+that it will become Test::Harness 3.0.
 
-A README file is required for CPAN modules since CPAN extracts the README
-file from a module distribution so that people browsing the archive
-can use it get an idea of the modules uses. It is usually a good idea
-to provide version information here so that people can decide whether
-fixes for the module are worth downloading.
-
 INSTALLATION
 
-To install this module, run the following commands:
+To install TAP::Parser using ExtUtils::MakeMaker do:
 
+    perl Makefile.PL
+    make
+    make test
+    make install
+
+To use Module::Build do:
+
     perl Build.PL
     ./Build
     ./Build test
     ./Build install
 
+If you elect to install the "runtests" program (you are prompted during
+perl {Makefile,Build}.PL) you will be able to run your tests against
+TAP::Parser from your modules home directory by running
 
+    runtests -rb
+
+See runtests --help for more information.
+
 COPYRIGHT AND LICENCE
 
 Copyright (C) 2006 Curtis "Ovid" Poe