Introduce C::D::G::{Atom,Version}

[perl/modules/CPANPLUS-Dist-Gentoo.git] / README

diff --git a/README b/README
index d770efc2c2dbbf2a3aabc2651e79bcbd796577d3..076666a5cfd71cb469600c41a30f2b61121b503b 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,7 @@ NAME
     CPANPLUS::Dist::Gentoo - CPANPLUS backend generating Gentoo ebuilds.
 
 VERSION
-    Version 0.02_01
+    Version 0.08
 
 SYNOPSIS
         cpan2dist --format=CPANPLUS::Dist::Gentoo \
@@ -10,30 +10,53 @@ SYNOPSIS
                   --dist-opts distdir=/usr/portage/distfiles \
                   --dist-opts manifest=yes \
                   --dist-opts keywords=x86 \
+                  --dist-opts header="# Copyright 1999-2008 Gentoo Foundation" \
+                  --dist-opts footer="# End" \
                   Any::Module You::Like
 
 DESCRPITON
     This module is a CPANPLUS backend that recursively generates Gentoo
     ebuilds for a given package in the specified overlay (defaults to
-    "/usr/local/portage"), update the manifest, and even emerge it (together
+    /usr/local/portage), updates the manifest, and even emerges it (together
     with its dependencies) if the user requires it. You need write
     permissions on the directory where Gentoo fetches its source files
-    (usually "/usr/portage/distfiles").
+    (usually /usr/portage/distfiles). The valid "KEYWORDS" for the generated
+    ebuilds are by default those given in "ACCEPT_KEYWORDS", but you can
+    specify your own with the "keywords" dist-option.
 
-    The generated ebuilds are placed into the section "perl-gcpanp". They
-    favour depending on "perl-core" or "dev-perl" rather than "perl-gcpanp".
+    The generated ebuilds are placed into the "perl-gcpanp" category. They
+    favour depending on a "virtual", on "perl-core", "dev-perl" or
+    "perl-gcpan" (in that order) rather than "perl-gcpanp".
+
+INSTALLATION
+    After installing this module, you should append "perl-gcpanp" to your
+    /etc/portage/categories file.
 
 METHODS
-    All the methods are inherited from CPANPLUS::Dist::Base. Please refer to
-    its perldoc for precise information on what's done at each step.
+    This module inherits all the methods from CPANPLUS::Dist::Base. Please
+    refer to its documentation for precise information on what's done at
+    each step.
+
+  "intuit_license"
+    Returns an array reference to a list of Gentoo licences identifiers
+    under which the current distribution is released.
+
+  "update_manifest"
+    Updates the Manifest file for the ebuild associated to the current dist
+    object.
+
+  "ebuild_source"
+    Returns the source of the ebuild for the current dist object, or "undef"
+    when one of the dependencies couldn't be mapped to an existing ebuild.
 
 DEPENDENCIES
     Gentoo (<http://gentoo.org>).
 
-    CPANPLUS, IPC::Cmd (core modules since 5.9.5).
+    CPANPLUS, IPC::Cmd (core modules since 5.9.5), Parse::CPAN::Meta (since
+    5.10.1).
 
-    File::Path (since 5.001), File::Copy (5.002), File::Spec::Functions
-    (5.00504).
+    Cwd, Carp (since perl 5), File::Path (5.001), File::Copy (5.002),
+    File::Spec (5.00405), List::Util (5.007003).
 
 SEE ALSO
     cpan2dist.
@@ -43,6 +66,8 @@ SEE ALSO
 AUTHOR
     Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.
 
+    You can contact me by mail or on "irc.perl.org" (vincent).
+
 BUGS
     Please report any bugs or feature requests to "bug-cpanplus-dist-gentoo
     at rt.cpan.org", or through the web interface at
@@ -56,11 +81,12 @@ SUPPORT
         perldoc CPANPLUS::Dist::Gentoo
 
 ACKNOWLEDGEMENTS
-    The module is to some extend cargo-culted from CPANPLUS::Dist::Deb and
-    CPANPLUS::Dist::Mdv.
+    The module was inspired by CPANPLUS::Dist::Deb and CPANPLUS::Dist::Mdv.
+
+    Kent Fredric, for testing and suggesting improvements.
 
 COPYRIGHT & LICENSE
-    Copyright 2008 Vincent Pit, all rights reserved.
+    Copyright 2008-2009 Vincent Pit, all rights reserved.
 
     This program is free software; you can redistribute it and/or modify it
     under the same terms as Perl itself.