New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved Documentation (Auto readme.pod) #10

Merged
merged 4 commits into from Jan 20, 2015

Conversation

Projects
None yet
2 participants
@kyzn
Contributor

kyzn commented Jan 17, 2015

Here's another try: Now I have edited Build.PL file so that it generates github-friendly Readme.pod file as well as traditional Readme file. Generated Readme files are committed.
I have referred to the post at http://blogs.perl.org/users/michal_wojciechowski/2011/11/github-friendly-readme-files-with-extutils-makemaker-and-module-build.html upon making the changes.
Hope you find this PR useful. (This contribution is part of CPAN-PR challenge)

@exodist

This comment has been minimized.

Show comment
Hide comment
@exodist

exodist Jan 17, 2015

Owner

How does it work?

When I built dists it would take the POD from Exporter::Declare and turn it into the README text. What happens after this change, does it generate both?

Owner

exodist commented Jan 17, 2015

How does it work?

When I built dists it would take the POD from Exporter::Declare and turn it into the README text. What happens after this change, does it generate both?

@kyzn

This comment has been minimized.

Show comment
Hide comment
@kyzn

kyzn Jan 17, 2015

Contributor

It does the same: It gets the text from Exporter/Declare.pm and generates two readme files: One with markup, one without. It makes use of POD::Select and POD::Readme. (I added them as dependencies in Build.PL, but it makes sense if you don't want to increase number of dependencies.)

Contributor

kyzn commented Jan 17, 2015

It does the same: It gets the text from Exporter/Declare.pm and generates two readme files: One with markup, one without. It makes use of POD::Select and POD::Readme. (I added them as dependencies in Build.PL, but it makes sense if you don't want to increase number of dependencies.)

@exodist

This comment has been minimized.

Show comment
Hide comment
@exodist

exodist Jan 17, 2015

Owner

They are only dependencies for building a package. They are not needed when installing or testing, correct? In that case they do not need to be listed as deps.

Owner

exodist commented Jan 17, 2015

They are only dependencies for building a package. They are not needed when installing or testing, correct? In that case they do not need to be listed as deps.

@kyzn

This comment has been minimized.

Show comment
Hide comment
@kyzn

kyzn Jan 17, 2015

Contributor

Well, that makes sense. I thought they were needed because on the blog-post I referred above it was explicitly noted that way: "Remember to add the Pod::Select and Pod::Readme modules to configure_requires and build_requires, as shown in the above example." I will remove them immediately.

Contributor

kyzn commented Jan 17, 2015

Well, that makes sense. I thought they were needed because on the blog-post I referred above it was explicitly noted that way: "Remember to add the Pod::Select and Pod::Readme modules to configure_requires and build_requires, as shown in the above example." I will remove them immediately.

@exodist

This comment has been minimized.

Show comment
Hide comment
@exodist

exodist Jan 17, 2015

Owner

Hmm. I will run some tests. I am not able to merge today, but I will try to
get to it within the next week. Thanks, this is nice.
On Jan 17, 2015 1:18 PM, "Kivanc Yazan" notifications@github.com wrote:

Well, that makes sense. I thought they were needed because on the
blog-post I referred above it was explicitly noted that way: "Remember to
add the Pod::Select and Pod::Readme modules to configure_requires and
build_requires, as shown in the above example." I will remove them
immediately.


Reply to this email directly or view it on GitHub
#10 (comment)
.

Owner

exodist commented Jan 17, 2015

Hmm. I will run some tests. I am not able to merge today, but I will try to
get to it within the next week. Thanks, this is nice.
On Jan 17, 2015 1:18 PM, "Kivanc Yazan" notifications@github.com wrote:

Well, that makes sense. I thought they were needed because on the
blog-post I referred above it was explicitly noted that way: "Remember to
add the Pod::Select and Pod::Readme modules to configure_requires and
build_requires, as shown in the above example." I will remove them
immediately.


Reply to this email directly or view it on GitHub
#10 (comment)
.

@kyzn

This comment has been minimized.

Show comment
Hide comment
@kyzn

kyzn Jan 17, 2015

Contributor

Great news to hear! Hope it builds with no problems. Please leave any comments if I can improve it in any way.

Contributor

kyzn commented Jan 17, 2015

Great news to hear! Hope it builds with no problems. Please leave any comments if I can improve it in any way.

@exodist exodist merged commit acd931c into exodist:master Jan 20, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment