Parrot programming documentation site project
JavaScript Perl
Pull request Compare This branch is 11 commits ahead, 10 commits behind jonallen:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
resources
script
site
t
.gitignore
Changes
LICENSE
MANIFEST
Makefile.PL
README
build-perldoc-html.pl
build-perldoc-js.pl
build-perldoc-pdf.pl
build-perldoc-static.pl
build-perldoc.pl
ignore.txt
opensearch.xml
syntax.cache

README

----------------------
- perldoc.parrot.org -
----------------------

DESCRIPTION

This archive contains the sourcecode for a hypothetical perldoc.parrot.org site,
which would hold core documentation for Parrot in HTML and PDF formats.

You can find the source for this project at

    http://github.com/brianwisti/perldoc.parrot.org

It is derived directly from Jon Allen's perldoc project, and owes many saved 
headaches to his hard work.

You can find information about the original perldoc project at

    http://perl.jonallen.info/projects/perldoc


USAGE

  perl -Ilib build.pl \
    --parrot=<parrot-folder> --out=<output-folder> [options]

where [options] are:

    --help        Print brief help message and exit
    --man         Print the manual page and exit
    --parrot=s    Find Parrot files in this folder
    --out=s       Write doc site to this folder
    --resources=s Find templates and static files here
    --verbose     Print many progress and status messages

NOTES

Please be aware that this software was written for the specific purpose
of generating the perldoc.parrot.org website, and not to solve generic
problems like "convert a directory of Pod to HTML" or "produce documentation
for Parrot and all modules installed on my system". However, the templates,
CSS, and conversion routines should give you a head start should you wish
to write a more generic tool.


LICENSE

Unless stated otherwise, all files are Copyright (C) Brian Wisti and
distributed under the terms of the Artistic License version 2.0.

This entire package is a modified copy of perldoc.perl.org. 
perldoc.perl.org is Copyright (C) Jon Allen and
distributed under the terms of the Artistic License version 2.0.

The Perl Onion logo is a trademark of The Perl Foundation. See
http://www.perlfoundation.org/perl_trademark for usage details.

A modified copy of the Pod::POM module is included in the lib/ directory.
Pod::POM is Copyright (C) 2000-2002 Andy Wardley and distributed under the
same terms as Perl itself.


CONTACT

Brian Wisti <brian.wisti@gmail.com>
http://github.com/brianwisti/perldoc.parrot.org