libsub-name-perl/INSTALL

76 lines
2.3 KiB
Plaintext
Raw Normal View History

2022-09-02 13:48:07 +08:00
This is the Perl distribution Sub-Name.
Installing Sub-Name is straightforward.
## Installation with cpanm
If you have cpanm, you only need one line:
% cpanm Sub::Name
If it does not have permission to install modules to the current perl, cpanm
will automatically set up and install to a local::lib in your home directory.
See the local::lib documentation (https://metacpan.org/pod/local::lib) for
details on enabling it in your environment.
## Installing with the CPAN shell
Alternatively, if your CPAN shell is set up, you should just be able to do:
% cpan Sub::Name
## Manual installation
2024-07-09 16:58:49 +08:00
As a last resort, you can manually install it. If you have not already
downloaded the release tarball, you can find the download link on the module's
MetaCPAN page: https://metacpan.org/pod/Sub::Name
Untar the tarball, install configure prerequisites (see below), then build it:
2022-09-02 13:48:07 +08:00
% perl Makefile.PL
% make && make test
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:
% perldoc Sub::Name
For more information on installing Perl modules via CPAN, please see:
https://www.cpan.org/modules/INSTALL.html