Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
generate README.md and README.pod at build time #9
Hi Tudor, thanks for your contribution, these cpan pull request challenges are a great!
That being said, I'm not a big fan of providing the same content in several formats in a distribution. If the main .pm file is the source of truth for the README (as in this module), there's no need for the distro to provide README.pod or README.md, as anyone interested in generating those could do so at their end, and without requiring everyone else to pull in dependencies (like Pod::Markdown) they don't need.
Please understand that I'm going to pass on this one, but don't let this stop you from providing much needed improvements to CPAN modules!
And thank you for your response. That's ok, I don't mind if you won't
On Tue, Jul 28, 2015 at 8:15 AM, Mike Schilli firstname.lastname@example.org
I totally agree, having a rich README would definitely be a plus (right now, it's actually kind of odd that we generated the README from the source of truth (the .pm) and that it is even worse in terms of markup, but I digress), but instead of patching thousands of CPAN modules, it'd be great if Github (or other hosters) would simply do it for us. This way, we only need to do it once and in one place!