2011年7月25日 星期一

Module::Install 將 Pod 轉為 Markdown Readme

常在 Github 上開發 Perl Module 覺得 README 跟 module file 內的 pod 同步、維護相當麻煩嗎?

可以安裝 Module::Install::ReadmeMarkdownFromPod 自動將 module pod 轉為 markdown 格式的 readme。

安裝:


sudo cpanm Module::Install::ReadmeMarkdownFromPod


使用:

於 Makefile.PL 內:


# in Makefile.PL

           use inc::Module::Install;
           name 'Some−Module';
           readme_markdown_from 'lib/Some/Module.pm';


最後 perl Makefile.PL 即可產生 Markdown format 的 Readme,便可在 github project 首頁顯示了。