Skip to content
This repository has been archived by the owner on Mar 7, 2019. It is now read-only.

[PRC] Reorganize navigation of documentation #187

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 13 additions & 2 deletions README
Expand Up @@ -13,12 +13,23 @@ To install Alien::Base, use cpanminus:

cpanm Alien::Base

If you have downloaded this from GitHub or locally, do

cpanm --installdeps .
cpanm .

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
perldoc Alien::Base::ModuleBuild::Authoring
perldoc Alien::Build::Manual::AlienAuthor

(this one installed in a separate module)

http://metacpan.org/pod/Alien::Base::ModuleBuild::Authoring
http://metacpan.org/pod/Alien::Build::Manual::AlienAuthor


The FAQ also contains hints on dealing with specific challenges, like
dealing with specific tools:
Expand Down
3 changes: 3 additions & 0 deletions cpanfile
@@ -0,0 +1,3 @@
requires "Alien::Base::ModuleBuild", ">=0.040";
requires "FFI::CheckLib", ">=0.11";
requires "Test2::Suite", ">=0.000060";
12 changes: 2 additions & 10 deletions lib/Alien/Base/Authoring.pod
Expand Up @@ -10,15 +10,7 @@ Alien::Base::Authoring - Authoring an Alien distribution using Alien::Base
=head1 DESCRIPTION

This used to document the only way to author an L<Alien> distribution, which
was with L<Aien::Base::ModuleBuild>. You should now seriously consider using
the newer more reliable method which is via L<Alien::Build> and L<alienfile>.

=over 4

=item L<Alien::Build::Manual::AlienAuthor>

=item L<Alien::Base::ModuleBuild::Authoring>

=back
was with L<Alien::Base::ModuleBuild>. You should now seriously consider using
the newer more reliable method which is via L<Alien::Build> and L<alienfile>. Read all about it in L<Alien::Build::Manual::AlienAuthor> and L<Alien::Base::ModuleBuild::Authoring>

=cut