让github使用perldoc来显示自述文件

时间:2012-08-07 13:45:32

标签: perl github

我可以配置github来显示perldoc的自述文件吗?模块(.pm)上传到那里,我只想让github自动生成一些由perldoc module.pm生成的输出(我不应该一直在自己更改readme.md)

1 个答案:

答案 0 :(得分:6)

Github会自动处理“README.pod”文件according to their documentation。创建和维护README.pod取决于您。如果您不想手动维护,可以考虑使用一些本地自动化工具来维护它。

单独维护README有一些好处。例如,Perl模块的POD通常不包含安装说明,但这些是您希望在README文件中找到的第一件事。