This is the README file for CPANPLUS, Ameliorated interface to
the Comprehensive Perl Archive Network, by Jos Boumans.

Please type "perldoc CPANPLUS" after installation to see the
module usage information. For shell usage, please consult
"perldoc cpanp"; the FAQ is available as "perldoc CPANPLUS::FAQ".

You may also want to read the 'ChangeLog' file, which describes new
features, bugfixes and additional notes for this release.

###################################################################
###
### Installation
###
###################################################################

CPANPLUS uses the standard perl module install process:

    $ perl Makefile.PL
    $ make                    # or 'nmake' on Windows
    $ make test
    $ make install

After installation you can start CPANPLUS' interactive client
by running one of the following commands:

    $ cpanp
    $ perl -MCPANPLUS -eshell

CPANPLUS also ships a 'boxed' cpanp client, so you can run it
out of it's extraction dir, by typing:

    $ perl bin/cpanp-boxed

This may help you with bootstrap issues, or other situations
where you need to use CPANPLUS but can not use a system installation.

You can install all of CPANPLUS' dependencies like this, before
installing CPANPLUS itself by running:

    $ perl bin/cpanp-boxed -s selfupdate dependencies

All the modules bundled are found in the 'inc/bundle' directory. If
you, for whatever reason, wish to not install these from cpan, you
could include them into your environment as such (using tcsh):

    $ setenv PERL5LIB `pwd`/inc/bundle


###################################################################
###
### Notes for windows users
###
###################################################################

If you are using Microsoft Windows, you will probably need the 'nmake'
utility before installation. It's available at:

    http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/nmake15.exe

If you are connected to the internet, "perl Makefile.PL" is capable
of automatically fetch it, and install into your Perl/bin directory.
You will see a message like this:

    The required 'nmake' executable not found, fetching it...

However, if you are not yet online, or wish to install 'nmake' into
another directory, then please download the file manually, save it to
a directory in %PATH (e.g. C:\WINDOWS\COMMAND), then launch the MS-DOS
command line shell, "cd" to that directory, and run "nmake15.exe" from
there; that will create the 'nmake.exe' file.

You may then resume the installation process above, but replace 'make'
with 'nmake' in the last three lines.


###################################################################
###
### Notes on CPAN testing
###
###################################################################

CPANPLUS offers several features to query and report module testing results.

For example, typing "cpanp -c DBI" in the command line (or "c DBI" in
the CPANPLUS default shell) will display the test results of latest
DBI package.

If you wish to report module test results as part of installation process,
please answer "Y" to the 'Report tests results? [y/N]:' question during
the interactive configuration. You can also type "s edit" in the CPANPLUS
Default Shell to edit the config file manually, or just enter "s conf
cpantest 1" and "s save" to save the settings.

Please consult the CPAN Tester's Website (http://testers.cpan.org/) for
detailed information.


###################################################################
###
### Contact
###
###################################################################

CPANPLUS has several mailing lists you can write to:

- Questions/suggestions:    <bug-cpanplus@rt.cpan.org> 
- Bug reporting:            <bug-cpanplus@rt.cpan.org>

###################################################################
###
### License
###
###################################################################

Copyright 2001-2006 by Jos Boumans <kane@cpan.org>.

All rights reserved.  You can redistribute and/or modify
this bundle under the same terms as Perl itself.

See <http://www.perl.com/perl/misc/Artistic.html>.

