Generate README automatically and keep out of git.

rjbs · Mar 18, 2012 · 05c41b4 · 05c41b4
1 parent faff3c4
commit 05c41b4
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 127 deletions.
diff --git a/.gitignore b/.gitignore
@@ -24,3 +24,4 @@ dll.base
 dll.exp
 Devel-Cover-*
 tags
+README
diff --git a/Makefile.PL b/Makefile.PL
@@ -313,9 +313,9 @@ WriteMakefile
                             "Test::Warn"  => 0,
                         },
     TYPEMAPS         => [ "utils/typemap" ],
-    clean            => { FILES    => "t/e2e/* cover_db* t/e2e/*cover_db"  },
-    dist             => { COMPRESS => "gzip --best --force"                },
-    test             => { TESTS    => "t/*/*.t"                            },
+    clean            => { FILES => "t/e2e/* cover_db* t/e2e/*cover_db README" },
+    dist             => { COMPRESS => "gzip --best --force"                   },
+    test             => { TESTS    => "t/*/*.t"                               },
     realclean        => $] < 5.008008 ?
                         {
                             FILES => "lib/Devel/Cover/Inc.pm",

diff --git a/README b/README
diff --git a/dist.ini b/dist.ini
@@ -7,12 +7,13 @@ copyright_holder = PJCJ
 ; also update makefile and generate meta files with makefile
 version = 0.79
 
-[GatherDir]                 ; gathers files from the dist dir
+[GatherDir]                 ; gather files from the dist dir
 include_dotfiles = 1
-[ManifestSkip]              ; removes gathered files specified by MANIFEST.SKIP
-[ExecDir]                   ; marks bin as the dir to contain scripts
-[OurPkgVersion]             ; adds versions to the packages
-[PodVersion]                ; adds versions to the POD of packages
+[ManifestSkip]              ; remove gathered files specified by MANIFEST.SKIP
+[ExecDir]                   ; mark bin as the dir to contain scripts
+[OurPkgVersion]             ; add versions to the packages
+[PodVersion]                ; add versions to the POD of packages
+; [License]                   ; add LICENCE file
 
 [Manifest]                  ; builds the manifest from the gathered files
 
@@ -24,14 +25,17 @@ format = Release %v - %{d}dth %{MMMM yyyy}d
 [ConfirmRelease]            ; asks for manual confirmation of release
 [UploadToCPAN]              ; uploads to cpan
 
+[Run::BeforeBuild]
+run = make README
+
+; [Run::AfterBuild]
+; run = chdir %d && %x -e 'rename "LICENSE" => "LICENCE"'  # yeah, yeah, yeah
 
 ; following can do stuff, but aren't used yet
 ;[ExtraTests]
 ;[PruneCruft    ]
 ;[MetaYAML      ] ; builds META.yaml
 ;[MetaJSON      ] ; builds META.json
-;[License       ]
-;[Readme        ]
 ;[ShareDir      ]
 ;[MakeMaker     ]