読者です 読者をやめる 読者になる 読者になる

モジュールをGithubに上げる際はトップのディレクトリに README.pod というエイリアスを貼ってほしいと勝手に主張したい件

Githubのページを開いたら、そこには

This is Perl module XXX::XXXX:::XXX.

INSTALLATION

Install cpanm (App::cpanminus) and then run the following command to install
HTML::Pictogram::MobileJp::TypeCast:

    $ cpanm XXX::XXXX:::XXX
...

という説明しかなく、「俺が欲しいのはHow to Installじゃないよ! SYNOPSISが見たいのだよ!」と仕方なく lib ディレクトリへのリンクをクリックする人は少なくないはずだ。

まあ、PODを .pm ファイルから READMEにコピるなんて面倒くさいもんね。


しかしGithubでは、PODの書かれた .pm ファイルを トップのディレクトリに README.pod という名前でエイリアスを貼れば、 .pm ファイルから POD 部分を抽出 & 整形して表示してくれる。

例: https://github.com/tokuhirom/Web-Query

エイリアスなので当然変更についてきてくれるわけで、管理の手間はない。だからGithubに上げる際にはこの作業だけしてくれると(主に僕とかが)超たすかります。