Skip to content

Commit

Permalink
Added "make README.md" to regenerated README.md from lib/Perl/Critic.pm
Browse files Browse the repository at this point in the history
  • Loading branch information
petdance committed May 20, 2017
1 parent b194197 commit ed7f839
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 9 deletions.
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ META.json
META.yml
MYMETA.json
MYMETA.yml
Makefile
Makefile.old
# This README is autogenerated by Module::Build and ships with the module. README.md is for GitHub.
README
_build/
Expand Down
5 changes: 5 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.PHONY: README.md

README.md:
cat README-prologue.md > README.md
pod2markdown lib/Perl/Critic.pm >> README.md
6 changes: 6 additions & 0 deletions README-prologue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# BUILD STATUS

* [![Travis Status](https://travis-ci.org/Perl-Critic/Perl-Critic.svg?branch=dev)](https://travis-ci.org/Perl-Critic/Perl-Critic)
* [CPAN Testers](http://cpantesters.org/distro/P/Perl-Critic.html)


15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# NAME

Perl::Critic - Critique Perl source code for best-practices.

# BUILD STATUS

* [![Travis Status](https://travis-ci.org/Perl-Critic/Perl-Critic.svg?branch=dev)](https://travis-ci.org/Perl-Critic/Perl-Critic)
* [CPAN Testers](http://cpantesters.org/distro/P/Perl-Critic.html)


# NAME

Perl::Critic - Critique Perl source code for best-practices.

# SYNOPSIS

use Perl::Critic;
Expand Down Expand Up @@ -567,8 +568,8 @@ modules.

If you develop any new Policy modules, feel free to send them to `<team@perlcritic.com>` and I'll be happy to consider putting them into the
Perl::Critic distribution. Or if you would like to work on the Perl::Critic
project directly, you can fork our repository at ["/github.com/Perl-
Critic/Perl- Critic.git" in http:](https://metacpan.org/pod/http:#github.com-Perl--Critic-Perl--Critic.git).
project directly, you can fork our repository at
[http://github.com/Perl-Critic/Perl-Critic.git](http://github.com/Perl-Critic/Perl-Critic.git).

The Perl::Critic team is also available for hire. If your organization has
its own coding standards, we can create custom Policies to enforce your local
Expand Down Expand Up @@ -699,7 +700,7 @@ Dolan's project to implement twenty PBP policies.

# AUTHOR

Jeffrey Ryan Thalhammer &lt;jeff@imaginative-software.com>
Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>

# COPYRIGHT

Expand Down

0 comments on commit ed7f839

Please sign in to comment.