Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
91 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
=pod | ||
|
||
=head1 NAME | ||
|
||
libperl++ - Install | ||
|
||
=head1 VERSION | ||
|
||
XXX | ||
=head1 SYNOPSIS | ||
|
||
perl Build.PL | ||
./Build | ||
./Build test | ||
./Build install | ||
|
||
=head1 BEFORE YOU START | ||
|
||
libperl++ requires a number of things to build it | ||
|
||
=over 4 | ||
|
||
=item * perl 5.8 or higher. perl 5.10 or higher is recommended. | ||
|
||
=item * A recent C++ compiler. Currently supported are | ||
|
||
=over 2 | ||
|
||
=item * GCC 4.4 or higher | ||
|
||
=item * MS Visual C++ 2010 | ||
|
||
=back | ||
|
||
Recent version of the Intel and Codeweavers compilers may work, but have not been tested in any way. | ||
|
||
=item * The Boost libraries. Note that this only includes headers, not runtime libraries. | ||
|
||
=back | ||
|
||
=head1 BUILDING | ||
|
||
libperl++'s build process is Build.PL compatible. All actions take options in the form C<options=value>, though if no value is given 1 is assumed. | ||
|
||
=head2 Creating the Build executable | ||
|
||
The Build executable can be generated by issuing | ||
|
||
perl Build.PL | ||
|
||
Any options given to it will be saved and passed on to all subsequent calls of Build. Most options for Build actions are specific for that action, except C<silent>, which is used by almost all Build actions. The default is 0. | ||
|
||
=head2 Building the library | ||
|
||
./Build | ||
|
||
it does not take any specific options. | ||
|
||
=head2 Running tests | ||
|
||
./Build test | ||
|
||
The amount of information given depends on the value of C<silent>. It can take values from -1 to 3, from printing out individual tests to printing out nothing. | ||
|
||
=head2 Installing the library | ||
|
||
./Build install | ||
|
||
Install can take a number of options | ||
|
||
=over 4 | ||
|
||
=item * libdir: the location where the libperl++ library will be installed. The default is installation dependent. | ||
|
||
=item * incdir: the location where libperl++ headers will be installed. The default is installation dependent. | ||
|
||
=item * moddir: the location there helper modules will be installed. The default is installation dependent. | ||
|
||
=item * dry_run: if this is true it will print out what it was planning to do without actually doing it. Defaults to false. | ||
|
||
=back | ||
|
||
=cut | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters