Update docs.

ingydotnet · Dec 18, 2014 · 6a55b53 · 6a55b53
1 parent dc24a7a
commit 6a55b53
Show file tree

Hide file tree

Showing 2 changed files with 142 additions and 4 deletions.
diff --git a/ReadMe.pod b/ReadMe.pod
@@ -0,0 +1,92 @@
+=pod
+
+=for comment
+DO NOT EDIT. This Pod was generated by Swim v0.1.31.
+See http://github.com/ingydotnet/swim-pm#readme
+
+=encoding utf8
+
+=head1 NAME
+
+Acme::Math::XS - Math is HARD (faster!)
+
+=for html
+<a href="https://travis-ci.org/ingydotnet/acme-math-xs-pm"><img src="https://travis-ci.org/ingydotnet/acme-math-xs-pm.png" alt="acme-math-xs-pm"></a>
+
+=head1 SYNOPSIS
+
+    use Acme::Math::XS;
+
+    print "2 + 2 = ${\add(2, 2)}\n";
+
+=head1 DESCRIPTION
+
+This is a tiny example "XS" module. It was written to show how one would write
+the same thing using L<Inline::Module>, L<Inline>, L<Inline::C> and
+L<Inline::CPP>.
+
+It has a pure "XS" version and "Alt"(ternate) modules for all the common CPAN
+module frameworks.
+
+The source code for all these modules is in one git repository, on separate
+branches: <https://github.com/ingydotnet/acme-math-xs-pm>
+
+=head1 SEE
+
+=over
+
+=item L<Acme::Math::XS>
+
+Pure XS version, shipped with L<ExtUtils::MakeMaker>.
+
+=item L<Alt::Acme::Math::XS::EUMM>
+
+L<Inline::Module> (using L<Inline::C>) version shipped with plain old
+L<ExtUtils::MakeMaker>.
+
+=item L<Alt::Acme::Math::XS::DistZilla>
+
+L<Inline::Module> version shipped with L<Dist::Zilla> and
+L<Dist::Zilla::Plugin::InlineModule>.
+
+=item L<Alt::Acme::Math::XS::ZillaDist>
+
+L<Inline::Module> version shipped with L<Zilla::Dist>.
+
+=item L<Alt::Acme::Math::XS::ModuleBuild>
+
+L<Inline::Module> version shipped with L<Module::Build> and
+L<Module::Build::InlineModule>.
+
+=item L<Alt::Acme::Math::XS::ModuleInstall>
+
+L<Inline::Module> version shipped with L<Module::Build> and
+L<Module::Build::InlineModule>.
+
+=item L<Alt::Acme::Math::XS::CPP>
+
+L<Inline::Module> (using L<Inline::CPP>) version shipped with
+L<ExtUtils::MakeMaker>.
+
+=back
+
+=head1 AUTHORS
+
+=over
+
+=item * Ingy döt Net <ingy@cpan.org>
+
+=item * David Oswald <davido@cpan.org>
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2014. Ingy döt Net.
+
+This program is free software; you can redistribute it and/or modify it under
+the same terms as Perl itself.
+
+See L<http://www.perl.com/perl/misc/Artistic.html>
+
+=cut
diff --git a/lib/Acme/Math/XS.pod b/lib/Acme/Math/XS.pod
@@ -1,18 +1,17 @@
 =pod
 
 =for comment
-DO NOT EDIT. This Pod was generated by Swim v0.1.30.
+DO NOT EDIT. This Pod was generated by Swim v0.1.31.
 See http://github.com/ingydotnet/swim-pm#readme
 
 =encoding utf8
 
 =head1 NAME
 
-Acme::Math::XS - Math is HARD (faster)
+Acme::Math::XS - Math is HARD (faster!)
 
 =for html
 <a href="https://travis-ci.org/ingydotnet/acme-math-xs-pm"><img src="https://travis-ci.org/ingydotnet/acme-math-xs-pm.png" alt="acme-math-xs-pm"></a>
-<a href="https://coveralls.io/r/ingydotnet/acme-math-xs-pm?branch=master"><img src="https://coveralls.io/repos/ingydotnet/acme-math-xs-pm/badge.png" alt="acme-math-xs-pm"></a>
 
 =head1 SYNOPSIS
 
@@ -22,7 +21,54 @@ Acme::Math::XS - Math is HARD (faster)
 
 =head1 DESCRIPTION
 
-This is the smallest possible XS module written with Inline::C.
+This is a tiny example "XS" module. It was written to show how one would write
+the same thing using L<Inline::Module>, L<Inline>, L<Inline::C> and
+L<Inline::CPP>.
+
+It has a pure "XS" version and "Alt"(ternate) modules for all the common CPAN
+module frameworks.
+
+The source code for all these modules is in one git repository, on separate
+branches: <https://github.com/ingydotnet/acme-math-xs-pm>
+
+=head1 SEE
+
+=over
+
+=item L<Acme::Math::XS>
+
+Pure XS version, shipped with L<ExtUtils::MakeMaker>.
+
+=item L<Alt::Acme::Math::XS::EUMM>
+
+L<Inline::Module> (using L<Inline::C>) version shipped with plain old
+L<ExtUtils::MakeMaker>.
+
+=item L<Alt::Acme::Math::XS::DistZilla>
+
+L<Inline::Module> version shipped with L<Dist::Zilla> and
+L<Dist::Zilla::Plugin::InlineModule>.
+
+=item L<Alt::Acme::Math::XS::ZillaDist>
+
+L<Inline::Module> version shipped with L<Zilla::Dist>.
+
+=item L<Alt::Acme::Math::XS::ModuleBuild>
+
+L<Inline::Module> version shipped with L<Module::Build> and
+L<Module::Build::InlineModule>.
+
+=item L<Alt::Acme::Math::XS::ModuleInstall>
+
+L<Inline::Module> version shipped with L<Module::Build> and
+L<Module::Build::InlineModule>.
+
+=item L<Alt::Acme::Math::XS::CPP>
+
+L<Inline::Module> (using L<Inline::CPP>) version shipped with
+L<ExtUtils::MakeMaker>.
+
+=back
 
 =head1 AUTHORS