| 1 |
This is the Perl distribution XS-Object-Magic. |
| 2 |
|
| 3 |
Installing XS-Object-Magic is straightforward. |
| 4 |
|
| 5 |
## Installation with cpanm |
| 6 |
|
| 7 |
If you have cpanm, you only need one line: |
| 8 |
|
| 9 |
% cpanm XS::Object::Magic |
| 10 |
|
| 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. |
| 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 XS::Object::Magic |
| 21 |
|
| 22 |
## Manual installation |
| 23 |
|
| 24 |
As a last resort, you can manually install it. Download the tarball, untar it, |
| 25 |
install configure prerequisites (see below), then build it: |
| 26 |
|
| 27 |
% perl Makefile.PL |
| 28 |
% make && make test |
| 29 |
|
| 30 |
Then install it: |
| 31 |
|
| 32 |
% make install |
| 33 |
|
| 34 |
On Windows platforms, you should use `dmake` or `nmake`, instead of `make`. |
| 35 |
|
| 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 |
| 39 |
|
| 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 |
|
| 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 |
|
| 64 |
## Documentation |
| 65 |
|
| 66 |
XS-Object-Magic documentation is available as POD. |
| 67 |
You can run `perldoc` from a shell to read the documentation: |
| 68 |
|
| 69 |
% perldoc XS::Object::Magic |
| 70 |
|
| 71 |
For more information on installing Perl modules via CPAN, please see: |
| 72 |
https://www.cpan.org/modules/INSTALL.html |