| 1 | ## | ||
| 2 | # name: Stardoc | ||
| 3 | # abstract: Acmeist Documentation Toolset | ||
| 4 | # author: Ingy döt Net <ingy@cpan.org> | ||
| 5 | # copyright: 2011 | ||
| 6 | # license: perl | ||
| 7 | |||
| 8 | package Stardoc; | ||
| 9 | use 5.008003; | ||
| 10 | |||
| 11 | our $VERSION = '0.18'; | ||
| 12 | |||
| 13 | use IO::All 0.41; | ||
| 14 | use Mouse 0.93; | ||
| 15 | use Template::Toolkit::Simple 0.13; | ||
| 16 | use YAML::XS 0.35; | ||
| 17 | |||
| 18 | 1; | ||
| 19 | |||
| 20 | =head1 SYNOPSIS | ||
| 21 | |||
| 22 | use Stardoc; | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | Stardoc is a toolset for making programming documentation easier. | ||
| 27 | |||
| 28 | It is intended to one day be a way to write Acmeist documentation. That is, | ||
| 29 | documentation that you write once, and it works in all programming languages. | ||
| 30 | |||
| 31 | =head1 WARNING | ||
| 32 | |||
| 33 | This is a very early release. Don't use Stardoc yet. Things are still being | ||
| 34 | worked out. | ||
| 35 | |||
| 36 | =head1 CURRENT USAGE | ||
| 37 | |||
| 38 | Right now, you can use it to simplify your Perl module docs. | ||
| 39 | |||
| 40 | Take a look at the source code for this module. The POD lacks several standard | ||
| 41 | sections. These sections are generated from the information provided in the | ||
| 42 | special Stardoc section at the top. | ||
| 43 | |||
| 44 | The Stardoc section starts with C<##> and contains a YAML map or metadata. |