[p5sagit/Sub-Name.git] / INSTALL

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

As a last resort, you can manually install it. Download the tarball, untar it,
install configure prerequisites (see below), then build it:

    % 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
Commit	Line	Data
71457ae8	1	This is the Perl distribution Sub-Name.
	2
	3	Installing Sub-Name is straightforward.
	4
	5	## Installation with cpanm
	6
	7	If you have cpanm, you only need one line:
	8
	9	% cpanm Sub::Name
	10
63ea1fd0	11	If it does not have permission to install modules to the current perl, cpanm
	12	will automatically set up and install to a local::lib in your home directory.
	13	See the local::lib documentation (https://metacpan.org/pod/local::lib) for
	14	details on enabling it in your environment.
71457ae8	15
	16	## Installing with the CPAN shell
	17
	18	Alternatively, if your CPAN shell is set up, you should just be able to do:
	19
	20	% cpan Sub::Name
	21
	22	## Manual installation
	23
	24	As a last resort, you can manually install it. Download the tarball, untar it,
0d5b12bc	25	install configure prerequisites (see below), then build it:
71457ae8	26
	27	% perl Makefile.PL
	28	% make && make test
	29
	30	Then install it:
	31
	32	% make install
	33
b31a8a12	34	On Windows platforms, you should use `dmake` or `nmake`, instead of `make`.
b31a8a12	35
63ea1fd0	36	If your perl is system-managed, you can create a local::lib in your home
	37	directory to install modules to. For details, see the local::lib documentation:
	38	https://metacpan.org/pod/local::lib
71457ae8	39
b31a8a12	40	The prerequisites of this distribution will also have to be installed manually. The
	41	prerequisites are listed in one of the files: `MYMETA.yml` or `MYMETA.json` generated
	42	by running the manual build process described above.
	43
0d5b12bc	44	## Configure Prerequisites
	45
	46	This distribution requires other modules to be installed before this
	47	distribution's installer can be run. They can be found under the
	48	"configure_requires" key of META.yml or the
	49	"{prereqs}{configure}{requires}" key of META.json.
	50
	51	## Other Prerequisites
	52
	53	This distribution may require additional modules to be installed after running
	54	Makefile.PL.
	55	Look for prerequisites in the following phases:
	56
	57	* to run make, PHASE = build
	58	* to use the module code itself, PHASE = runtime
	59	* to run tests, PHASE = test
	60
	61	They can all be found in the "PHASE_requires" key of MYMETA.yml or the
	62	"{prereqs}{PHASE}{requires}" key of MYMETA.json.
	63
71457ae8	64	## Documentation
	65
	66	Sub-Name documentation is available as POD.
b31a8a12	67	You can run `perldoc` from a shell to read the documentation:
71457ae8	68
71457ae8	69	% perldoc Sub::Name
0d5b12bc	70
b31a8a12	71	For more information on installing Perl modules via CPAN, please see:
b31a8a12	72	https://www.cpan.org/modules/INSTALL.html