Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added documentation before 0.000_001 release

  • Loading branch information...
commit 28a66d48699b594b7665f63b5ee1c88347d81be9 1 parent 643ddc2
@jberger jberger authored
Showing with 53 additions and 0 deletions.
  1. +49 −0 lib/Alien/Base.pm
  2. +4 −0 lib/Alien/Base/Authoring.pod
View
49 lib/Alien/Base.pm
@@ -102,3 +102,52 @@ sub config {
1;
+__POD__
+=head1 NAME
+
+Alien::Base - Base classes for Alien:: modules
+
+=head1 SYNOPSIS
+
+ package Alien::MyLibrary;
+
+ use strict;
+ use warnings;
+
+ use parent 'Alien::Base';
+
+ 1;
+
+=head1 DESCRIPTION
+
+L<Alien::Base> comprises base classes to help in the construction of C<Alien::> modules. Modules in the L<Alien> namespace are used to locate and install (if necessary) external libraries needed by other Perl modules.
+
+This is the documentation for the L<Alien::Base> module itself. To learn more about the system as a whole please see L<Alien::Base::Authoring>.
+
+=head1 SEE ALSO
+
+=over
+
+=item *
+
+L<Alien>
+
+=back
+
+=head1 SOURCE REPOSITORY
+
+L<http://github.com/jberger/Tie-Array-CSV>
+
+=head1 AUTHOR
+
+Joel Berger, E<lt>joel.a.berger@gmail.comE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2012 by Joel Berger
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut
+
View
4 lib/Alien/Base/Authoring.pod
@@ -6,6 +6,10 @@ Alien::Base::Authoring - Authoring an C<Alien::> module
Congratulations! You have made the decision to help the Perl community by providing a C library via CPAN. The L<Alien> namespace has been instrumental in providing C libraries for many years, but authoring those modules has been a commitment that most authors weren't willing to take on. L<Alien::Base> tries to ease that pain by providing most of the needed functionality; usually authors should only need a little boilerplate and configuration!
+=head1 STATUS
+
+L<Alien::Base> is under heavy development and is currently pre-alpha. The author hopes that the API will stabilize soon, but currently there are no promises that ANY PART of the API will remain as-is. Please resist the temptation to use it for production code until the warning is removed. Of course you are welcomed, and in fact encouraged, to test it with for your favorite library; if you do, you are more than welcome to share your experience with me.
+
=head1 ECOSYSTEM
The L<Alien::Base> ecosystem is made up of several elements. Some of these elements are the base classes in the distribution itself. Of course, no ecosystem is complete without inhabitants, therefore, it is also important to consider the users of these base classes. This documentation will assume that you are writing C<Alien::MyLibrary> which provides F<libmylibrary.so>. Further it will assume that you or someone else is going to use this module/library to write C<Some::Module::MyLibrary>. Finally an end user might use that module to write F<myscript.pl>.
Please sign in to comment.
Something went wrong with that request. Please try again.