Recently it was pointed out to me that I was being too slack in not supplying READMEs with my modules that I upload to CPAN. It's true, I'm hugely slack, but mostly because a README ends up as a terrible mishmash of the documentation you already carefully (or reluctantly) wrote somewhere else. (synopsis, dependencies, change histories)
Now I don't claim to be anything like the first person to do this, but I've just had the simple pleasure of crafting a make target and dirty little perl script to make this pain go away. I therefore present you with makereadme, as used in the fothercoming release of File::Find::Rule (and probably all my other modules too, as it makes me look more productive than I really am).
Enjoy.
Re:That should be...
richardc on 2003-02-13T13:06:20
Or even some tortuous boilerplate like:make install
Note: you'll need to run the C<make install> step as a user with sufficient permission to write to the paths where perl modules are installed. This may be root, so you'd do something like <su -c 'make install'> or <sudo make install>.
Alternatively you want to read this guide on using non-standard install paths: L<http://www.cpan.org/misc/cpan-faq.html#How_install_private>And so on and so on. At least you get to worry about it just the twice.
