This repository has been archived by the owner on Mar 7, 2019. It is now read-only.
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
64 additions
and
8 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 |
---|---|---|
@@ -1,10 +1,42 @@ | ||
Alien::Base will is a base class to help build Alien:: modules for simple libraries. | ||
Alien::Base is a base class and framework for creating Alien | ||
distributions. The goal of the project is to make things as simple and | ||
easy as possible for both developers and users of Alien modules. | ||
|
||
Special thanks go out to: | ||
Alien is a Perl namespace for defining dependencies in CPAN for | ||
libraries and tools which are not "native" to CPAN. Alien modules will | ||
typically use the system libraries if they are available, or download | ||
the latest version from the internet and build them from source code. | ||
These libraries can then be used by other Perl modules, usually modules | ||
that are implemented with XS or FFI. | ||
|
||
To install Alien::Base, use cpanminus: | ||
|
||
cpanm Alien::Base | ||
|
||
Once installed you can read the project documentation using the perldoc | ||
command, or via the metacpan.org website. If you are an Alien | ||
developer, see the authoring documentation: | ||
|
||
perldoc Alien::Base::Authoring | ||
http://metacpan.org/pod/Alien::Base::Authoring | ||
|
||
The FAQ also contains hints on dealing with specific challenges, like | ||
dealing with specific tools: | ||
|
||
perldoc Alien::Base::FAQ | ||
http://metacpan.org/pod/Alien::Base::FAQ | ||
|
||
If you are a user of an Alien module, you will likely be more interested | ||
in the Alien::Base interface itself: | ||
|
||
perldoc Alien::Base | ||
http://metacpan.org/pod/Alien::Base | ||
|
||
For questions that aren't answered in the documentation, please feel | ||
free to contact the Alien::Base team: | ||
|
||
* IRC: #native on irc.perl.org | ||
* mailing list at https://groups.google.com/forum/#!forum/perl5-alien | ||
* GitHub issue tracker at https://github.com/Perl5-Alien/Alien-Base/issues | ||
|
||
- Christian Walde (Mithaldu) for productive conversations about component interoperablility, | ||
- kmx for writing Alien::Tidyp from which I drew many of my initial ideas, | ||
- David Mertens (run4flat) for productive conversations about implementation, | ||
- Mark Nunberg (mordy, mnunberg) for graciously teaching me about rpath and dynamic loading, | ||
- Brian Wightman (MidLifeXis) for code contributions | ||
|
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