Permalink
Browse files

readme.mkdn should be created in root dir

  • Loading branch information...
1 parent ec86943 commit 3d53c7e36a9b7f975357dd78b80ed50208af978f @jquelin committed Oct 9, 2012
Showing with 86 additions and 10 deletions.
  1. +1 −0 Changes
  2. +75 −0 README.mkdn
  3. +10 −10 lib/Dist/Zilla/PluginBundle/Author/JQUELIN.pm
View
@@ -1,6 +1,7 @@
Changelog for Dist-Zilla-PluginBundle-JQUELIN
{{$NEXT}}
+ - readme.mkdn should be created in root dir
3.000 2012-10-04 15:01:33 Europe/Paris
- using Git::NextVersion instead of AutoVersion
View
@@ -0,0 +1,75 @@
+# NAME
+
+Dist::Zilla::PluginBundle::Author::JQUELIN - Build & release a distribution like jquelin
+
+# VERSION
+
+version 3.001
+
+# SYNOPSIS
+
+In your `dist.ini`:
+
+ [@Author::JQUELIN]
+
+# DESCRIPTION
+
+This is a plugin bundle to load all plugins that I am using. Check the
+code to see exactly what are those plugins.
+
+The following options are accepted:
+
+- `weaver` - can be either `pod` (default) or `task`, to load
+respectively either [PodWeaver](http://search.cpan.org/perldoc?Dist::Zilla::Plugin::PodWeaver) or
+[TaskWeaver](http://search.cpan.org/perldoc?Dist::Zilla::Plugin::TaskWeaver).
+
+__NOTE:__ This bundle consumes
+[Dist::Zilla::Role::PluginBundle::Config::Slicer](http://search.cpan.org/perldoc?Dist::Zilla::Role::PluginBundle::Config::Slicer) so you can also
+specify attributes for any of the bundled plugins. The option should be
+the plugin name and the attribute separated by a dot:
+
+ [@JQUELIN]
+ AutoPrereqs.skip = Bad::Module
+
+See ["CONFIGURATION SYNTAX" in Config::MVP::Slicer](http://search.cpan.org/perldoc?Config::MVP::Slicer#CONFIGURATION SYNTAX) for more information.
+
+# SEE ALSO
+
+You can look for information on this module at:
+
+- Search CPAN
+
+[http://search.cpan.org/dist/Dist-Zilla-PluginBundle-Author-JQUELIN](http://search.cpan.org/dist/Dist-Zilla-PluginBundle-Author-JQUELIN)
+
+- See open / report bugs
+
+[http://rt.cpan.org/NoAuth/Bugs.html?Dist=Dist-Zilla-PluginBundle-Author-JQUELIN](http://rt.cpan.org/NoAuth/Bugs.html?Dist=Dist-Zilla-PluginBundle-Author-JQUELIN)
+
+- Mailing-list (same as dist-zilla)
+
+[http://www.listbox.com/subscribe/?list\_id=139292](http://www.listbox.com/subscribe/?list\_id=139292)
+
+- Git repository
+
+[http://github.com/jquelin/dist-zilla-pluginbundle-author-jquelin](http://github.com/jquelin/dist-zilla-pluginbundle-author-jquelin)
+
+- AnnoCPAN: Annotated CPAN documentation
+
+[http://annocpan.org/dist/Dist-Zilla-PluginBundle-Author-JQUELIN](http://annocpan.org/dist/Dist-Zilla-PluginBundle-Author-JQUELIN)
+
+- CPAN Ratings
+
+[http://cpanratings.perl.org/d/Dist-Zilla-PluginBundle-Author-JQUELIN](http://cpanratings.perl.org/d/Dist-Zilla-PluginBundle-Author-JQUELIN)
+
+See also: [Dist::Zilla::PluginBundle](http://search.cpan.org/perldoc?Dist::Zilla::PluginBundle).
+
+# AUTHOR
+
+Jerome Quelin
+
+# COPYRIGHT AND LICENSE
+
+This software is copyright (c) 2010 by Jerome Quelin.
+
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.
@@ -99,20 +99,20 @@ sub bundle_config {
[ MetaConfig => {} ],
# -- generate meta files
- [ HelpWanted => {} ],
- [ License => {} ],
- [ Covenant => {} ],
- [ MetaYAML => {} ],
- [ MetaJSON => {} ],
- [ ModuleBuild => {} ],
- [ Readme => {} ],
- [ ReadmeMarkdownFromPod => {} ],
- [ Manifest => {} ], # should come last
+ [ HelpWanted => {} ],
+ [ License => {} ],
+ [ Covenant => {} ],
+ [ MetaYAML => {} ],
+ [ MetaJSON => {} ],
+ [ ModuleBuild => {} ],
+ [ Readme => {} ],
+ [ ReadmeAnyFromPod => { location => "root", type => "markdown" } ],
+ [ Manifest => {} ], # should come last
# -- release
[ CheckChangeLog => {} ],
[ TestRelease => {} ],
- [ "Git::Check" => {} ],
+ [ "Git::Check" => { allow_dirty => "README.mkdn" } ],
[ "Git::Commit" => {} ],
[ "Git::Tag" => {} ],
[ "Git::Push" => {} ],

0 comments on commit 3d53c7e

Please sign in to comment.