On Sun, July 17, 2011 11:43 am, Jeffrey Kegler wrote:
> I'd like feedback on a question.  My feeling is that internals
> documentation
> is important, that disk is relatively cheap, and that I should include the
> PDF file that contains Marpa's internal documentation with the CPAN
> distribution.  But I'd like to know if others agree.

[ snip paragraph on 3M size]

>
> The sources of the PDF are already in the Marpa::XS distribution, but Cweb
> and TeX are required to build the PDF.  Cweb and Tex can be complicated to
> install -- it's a lot to ask of someone taking a first look at the code.
> Even if you already have Tex, it can save a lot of trouble if the PDF is
> already built.
>

Slightly off-topic question: can the Cweb-TeX combination produce the
document in EPUB format? I ask only because a document of that type would
be very useful for an eBook reader (Nook/Kobo/Kindle), and it would make
more sense for for those of us with one of these devices... which would
give you even more reason to *not* have these end files stored in the
tarball.

A second, more useful (in my opinion) format would mean that much more
space taken up, and give you more reason to have a site other than CPAN
for your documentation.

     -john

Reply via email to