This is 0.04

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

diff --git a/README b/README
index 05c6e8d3b416ab41e16cff6bf054328b9f9c3892..013848e41239ffc9be24d044e46c8c3846a9a39d 100644 (file)
--- a/README
+++ b/README
@@ -2,29 +2,38 @@ NAME
     CPANPLUS::Dist::Gentoo - CPANPLUS backend generating Gentoo ebuilds.
 
 VERSION
-    Version 0.01
+    Version 0.04
 
 SYNOPSIS
         cpan2dist --format=CPANPLUS::Dist::Gentoo \
                   --dist-opts overlay=/usr/local/portage \
                   --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). You also need to specify the correct
+    keyword for your architecture if it differs from the default "x86".
 
-    The generated ebuilds are placed into the section "perl-cpanp". They
-    favour depending on "perl-core" or "dev-perl" rather than "perl-cpanp".
+    The generated ebuilds are placed into the "perl-gcpanp" category. They
+    favour depending 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.
+    its documentation for precise information on what's done at each step.
 
 DEPENDENCIES
     Gentoo (<http://gentoo.org>).
@@ -42,6 +51,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
@@ -58,6 +69,8 @@ ACKNOWLEDGEMENTS
     The module is to some extend cargo-culted from CPANPLUS::Dist::Deb and
     CPANPLUS::Dist::Mdv.
 
+    Kent Fredric, for testing and suggesting improvements.
+
 COPYRIGHT & LICENSE
     Copyright 2008 Vincent Pit, all rights reserved.