From c0f694d90ff666a69799ba12238cce5132a9cfee Mon Sep 17 00:00:00 2001 From: David D Lowe Date: Fri, 6 Feb 2015 19:32:48 +0000 Subject: [PATCH] Distribute README and README.md files Doing this will make this module pass the following Kwalitee test: http://cpants.cpanauthors.org/kwalitee/has_readme --- MANIFEST.SKIP | 2 +- README | 12 ++++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 README diff --git a/MANIFEST.SKIP b/MANIFEST.SKIP index 89f1c25..e71de2f 100644 --- a/MANIFEST.SKIP +++ b/MANIFEST.SKIP @@ -1 +1 @@ -^(?!lib/.*\.pm$|t/.*|inc/.*|xt/.*\.t$|xt/lib/.*\.pm$|(?-xism:[^/]*\.PL)$|(?-xism:Changes|MANIFEST|README|META\.yml)$|maint/(?-xism:[^.].*)$|t/.*global\-destruction\-helper\.pl$) +^(?!lib/.*\.pm$|t/.*|inc/.*|xt/.*\.t$|xt/lib/.*\.pm$|(?-xism:[^/]*\.PL)$|(?-xism:Changes|MANIFEST|README|README.md|META\.yml)$|maint/(?-xism:[^.].*)$|t/.*global\-destruction\-helper\.pl$) diff --git a/README b/README new file mode 100644 index 0000000..c9cff0f --- /dev/null +++ b/README @@ -0,0 +1,12 @@ +To install this module, run: + + perl Makefile.PL + make + make test + make install + +Note that you will need the Perl modules "inc::Module::Install", +"Module::Install::Repository", as well as the dependencies listed in +Makefile.PL, to install this module. + +You can find more information about this module in the file README.md