1Installation Instructions
2
3The instructions are basically as per any Perl module.
4
5
6INSTALLING AUTOMATICALLY
7------------------------
8
9The easiest way to install is via CPAN, CPANPLUS or cpanminus:
10
11CPAN:
12
13    % perl -MCPAN -e shell                    [as root]
14    > install Test::CPAN::Meta
15    > quit
16
17CPANPLUS:
18
19    % cpanp
20    > i Test::CPAN::Meta
21    > q
22
23cpanminus:
24
25    % cpanm Test::CPAN::Meta
26
27See your local documentation ('perldoc CPAN', 'perldoc CPANPLUS' or
28'perldoc cpanm') for further instructions on setting up and configuring your
29chosen installer.
30
31
32OBTAINING THE MODULE
33--------------------
34
35The latest release version of Test-CPAN-Meta can be downloaded
36from any CPAN site:
37
38    http://www.cpan.org/modules/by-authors/id/B/BA/BARBIE/
39    http://search.cpan.org/dist/Test-CPAN-Meta/
40
41Phrasebook is distributed as a gzipped tar archive file:
42
43    Test-CPAN-Meta-<version>.tar.gz
44
45where <version> represents the current version number, e.g. 0.01.
46
47To install the module, unpack the distribution archive to
48create an installation directory.  Something like this:
49
50    tar zxf Test-CPAN-Meta-0.01.tar.gz
51or
52    gunzip Test-CPAN-Meta-0.01.tar.gz
53    tar xf Test-CPAN-Meta-0.01.tar
54
55You can then 'cd' into the directory created,
56
57    cd Test-CPAN-Meta-0.01
58
59
60INSTALLING MANUALLY
61-------------------
62
63The 'make install' (done later) will install the modules and scripts on
64your system. You may need administrator privileges to perform this task.
65Alternately you can install the module to a local directory (see
66ExtUtils::MakeMaker for full details), e.g.
67
68    % perl Makefile.PL PREFIX=/home/me/
69
70Don't forget to update your PERL5LIB environment variable if you do
71this, or add a line to your script to tell Perl where to find the files,
72e.g.
73
74    use lib qw( /home/me/lib/perl5/site_perl/5.6.0 );
75
76If you're not after a custom location, just do:
77
78    % perl Makefile.PL
79
80If you are lacking any of the prerequisite modules, running that
81program will tell you. All prerequisites are available from CPAN.
82
83When you have them all:
84
85    % make && make test
86
87If there are any failures, it's best if you contact me. It may help
88other people who have the same problem.  I don't tend to read the Perl
89newsgroups or PerlMonks, so it's no use posting there.
90
91When you report your trouble, be sure to send me the following
92information;
93    + result of `perl -V'
94    + output from 'make test' - ideally do 'make test TEST_VERBOSE=1 >& errs'
95
96Send those to bug-Test-CPAN-Meta@rt.cpan.org and I'll get back to you as
97soon as I'm able.
98
99If it worked, then become root and type:
100
101    # make install
102
103Congratulations. You've just installed Test::CPAN::Meta.
104
105If you have a copy of cpantest installed, type:
106
107    % cpantest -g pass -nc -p `basename \`pwd\`` -auto
108
109Or:
110    % cpantest -g pass -nc -p Test-CPAN-Meta-0.01 -auto
111
112That will tell both me and other potential users that the module
113built correctly on your machine.
114
115Cheers,
116Barbie.
117http://www.missbarbell.co.uk/
118