DOC HOME SITE MAP MAN PAGES GNU INFO SEARCH
 

Pod::Readme



NAME

Pod::Readme - Convert POD to README file


SYNOPSIS

  use Pod::Readme;
  my $parser = Pod::Readme->new();
  # Read POD from STDIN and write to STDOUT
  $parser->parse_from_filehandle;
  # Read POD from Module.pm and write to README
  $parser->parse_from_file('Module.pm', 'README');
output

Override does not output anything if the ``README_SKIP'' flag is enabled.