名前¶

Module::Install::ReadmeFromPod - A Module::Install extension to automatically convert POD to a README

Module::Install::ReadmeFromPod - PODから READMEの自動変換を行うための Module::Install拡張

概要¶

  # In Makefile.PL

  use inc::Module::Install;
  author 'Vestan Pants';
  license 'perl';
  readme_from 'lib/Some/Module.pm';

A README file will be generated from the POD of the indicated module file.

Note that the author will need to make sure Module::Install::ReadmeFromPod is installed before running the Makefile.PL. (The extension will be bundled into the user-side distribution).

  # In Makefile.PL

  use inc::Module::Install;
  author 'Vestan Pants';
  license 'perl';
  readme_from 'lib/Some/Module.pm';

指定したモジュールファイルの PODから READMEが生成されます.

注記モジュール作者は Makefile.PLを実行する前に Module::Install::ReadmeFromPodをインストールしておく必要があります(ユーザ側では拡張モジュールは同梱されたものを利用します).

説明¶

Module::Install::ReadmeFromPod is a Module::Install extension that generates a README file automatically from an indicated file containing POD, whenever the author runs Makefile.PL.

Module::Install::ReadmeFromPodは Module::Installの拡張です. モジュール作者が Makefile.PLを実行したときに指定したファイルに含まれる PODから READMEを自動的に生成します.

COMMANDS¶

This plugin adds the following Module::Install command:

readme_from

Does nothing on the user-side. On the author-side it will generate a README file using Pod::Text from the POD in the file passed as a parameter.

  readme_from 'lib/Some/Module.pm';

If a second parameter is set to a true value then the README will be removed at make distclean.

  readme_from 'lib/Some/Module.pm' => 'clean';

If you use the all_from command, readme_from will default to that value.

  all_from 'lib/Some/Module.pm';
  readme_from;              # Create README from lib/Some/Module.pm
  readme_from '','clean';   # Put a empty string before 'clean'

このプラグインは Module::Installに以下に示すコマンドを追加します.

readme_from

ユーザ側では何もしません. モジュール作者側では, Pod::Textを使って引数として渡されたファイルの POD から READMEを生成します.

  readme_from 'lib/Some/Module.pm';

第二引数に真となる値が設定された場合は, make discleanを行った際に READMEを削除します.

  readme_from 'lib/Some/Module.pm' => 'clean';

all_fromコマンドを使うのであれば, readme_fromは all_fromに指定された値をデフォルトの値とします.

  all_from 'lib/Some/Module.pm';
  readme_from;              # lib/Some/Module.pmから READMEを生成します.
  readme_from '','clean';   # 'clean'の前には空文字列を設定してください.

作者¶

Chris BinGOs Williams

ライセンス¶

This module may be used, modified, and distributed under the same terms as Perl itself. Please see the license that came with your Perl distribution for details.

名前¶

概要¶

説明¶

COMMANDS¶

作者¶

ライセンス¶

SEE ALSO¶