[svn openjsan.org] [453] Added some documentation

[ca...@geeknest.com]

Revision: 453
Author: rob
Date: 2005-09-06 23:08:39 -0400 (Tue, 06 Sep 2005)

Log Message:
-----------
Added some documentation

Modified Paths:
--------------
perl/Module-Build-JSAN/trunk/lib/Module/Build/JSAN.pm
Modified: perl/Module-Build-JSAN/trunk/lib/Module/Build/JSAN.pm
===================================================================
--- perl/Module-Build-JSAN/trunk/lib/Module/Build/JSAN.pm 2005-09-07 03:07:28 UTC (rev 452)
+++ perl/Module-Build-JSAN/trunk/lib/Module/Build/JSAN.pm 2005-09-07 03:08:39 UTC (rev 453)
@@ -296,22 +296,65 @@

=head1 SYNOPSIS

+ use Module::Build::JSAN;

+ my $build = Module::Build::JSAN->new(
+ module_name => 'Foo-Bar',
+ license => 'perl',
+ dist_author => 'Joe Developer <j...@foobar.com>',
+ dist_abstract => 'Say something pithy here',
+ dist_version => '0.02',
+ keywords => [qw(Foo Bar pithyness)],
+ build_requires => {
+ 'Test.Simple' => 0.20,
+ },
+ requires => {
+ 'JSAN' => 0.10,
+ 'Baz-Quux' => 0.02,
+ },
+ );

+ $build->create_build_script;
+
=head1 DESCRIPTION

+This is a developer aid for creating JSAN distributions. Please use the example
+given in the SYNOPSIS to create distributions.

+This works nearly identically to L<Module::Build>, so please refer to its
+documentation.
+
+=head1 DIFFERENCES
+
+=over 4
+
+=item 1 META.json
+
+JSAN uses the JSON format instead of the YAML format, as it's legal Javascript
+and just plain easier to work with. This means that Module::Build::JSAN will
+generate META.json files instead of META.yml files. Do not be alarmed.
+
+=item 2 ./Build deps
+
+This is a new action added in Module::Build::JSAN. You run this in order to
+install your dependencies when testing while developing. This will allow you to
+develop against the latest versions of the distributions you are building upon.
+
+=back
+
=head1 BUGS

Please send bug reports to <bug-module...@rt.cpan.org>.

-=head1 AUTHOR
+=head1 AUTHORS

David Wheeler <da...@kineticode.com>
+Casey West <ca...@geeknest.com>
+Rob Kinyon <rob.k...@iinteractive.com>

=head1 COPYRIGHT AND LICENSE

-Copyright 2005 by David Wheeler
+Copyright 2005 by David Wheeler, Casey West, Rob Kinyon

This library is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.