X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=INSTALL;h=8f1f9d4c7a1f77c264ae4a8986d92c3453869e83;hb=master;hp=7a2308d5bc0c07616f4b500f5cff410ebe393b92;hpb=63ea1fd0b9fc09452f0e98ea0d0c0ada6e996b9a;p=p5sagit%2FSub-Name.git diff --git a/INSTALL b/INSTALL index 7a2308d..8f1f9d4 100644 --- a/INSTALL +++ b/INSTALL @@ -22,7 +22,7 @@ Alternatively, if your CPAN shell is set up, you should just be able to do: ## Manual installation As a last resort, you can manually install it. Download the tarball, untar it, -then build it: +install configure prerequisites (see below), then build it: % perl Makefile.PL % make && make test @@ -31,13 +31,42 @@ Then install it: % make install +On Windows platforms, you should use `dmake` or `nmake`, instead of `make`. + If your perl is system-managed, you can create a local::lib in your home directory to install modules to. For details, see the local::lib documentation: https://metacpan.org/pod/local::lib +The prerequisites of this distribution will also have to be installed manually. The +prerequisites are listed in one of the files: `MYMETA.yml` or `MYMETA.json` generated +by running the manual build process described above. + +## Configure Prerequisites + +This distribution requires other modules to be installed before this +distribution's installer can be run. They can be found under the +"configure_requires" key of META.yml or the +"{prereqs}{configure}{requires}" key of META.json. + +## Other Prerequisites + +This distribution may require additional modules to be installed after running +Makefile.PL. +Look for prerequisites in the following phases: + +* to run make, PHASE = build +* to use the module code itself, PHASE = runtime +* to run tests, PHASE = test + +They can all be found in the "PHASE_requires" key of MYMETA.yml or the +"{prereqs}{PHASE}{requires}" key of MYMETA.json. + ## Documentation Sub-Name documentation is available as POD. -You can run perldoc from a shell to read the documentation: +You can run `perldoc` from a shell to read the documentation: % perldoc Sub::Name + +For more information on installing Perl modules via CPAN, please see: +https://www.cpan.org/modules/INSTALL.html