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

added readme #20

Merged
merged 1 commit into from Feb 1, 2016

Conversation

Projects
None yet
2 participants
@ambs
Contributor

ambs commented Jan 26, 2016

kwalittee is complaining about the lack of a README.
Created this with pod2readme.
a little contribution, but better than nothing :)

@sni

This comment has been minimized.

Show comment
Hide comment
@sni

sni Jan 26, 2016

Owner

I don't like to maintain the same thing twice. Would a readme pointing to perldoc or the top level readme be enough?

Owner

sni commented Jan 26, 2016

I don't like to maintain the same thing twice. Would a readme pointing to perldoc or the top level readme be enough?

@ambs

This comment has been minimized.

Show comment
Hide comment
@ambs

ambs Jan 26, 2016

Contributor

Sure, or a code to generate automaticaly the README from the POD. What would you prefer?

Contributor

ambs commented Jan 26, 2016

Sure, or a code to generate automaticaly the README from the POD. What would you prefer?

@sni

This comment has been minimized.

Show comment
Hide comment
@sni

sni Jan 26, 2016

Owner

if you can put some code in the Makefile.PL, i would prefer that.

Owner

sni commented Jan 26, 2016

if you can put some code in the Makefile.PL, i would prefer that.

@ambs

This comment has been minimized.

Show comment
Hide comment
@ambs

ambs Jan 26, 2016

Contributor

Sure, will try.

Contributor

ambs commented Jan 26, 2016

Sure, will try.

@sni

This comment has been minimized.

Show comment
Hide comment
@sni

sni Jan 26, 2016

Owner

great, thanks. Please also add the README to the MANIFEST.SKIP and .gitignore then if it is autogenerated.

Owner

sni commented Jan 26, 2016

great, thanks. Please also add the README to the MANIFEST.SKIP and .gitignore then if it is autogenerated.

@ambs

This comment has been minimized.

Show comment
Hide comment
@ambs

ambs Jan 26, 2016

Contributor

In fact, I think kwalittee looks to the tarball prior running any code. So probably 'make dist' could generate it. Will see what's the best approach and let you know what I found.

Contributor

ambs commented Jan 26, 2016

In fact, I think kwalittee looks to the tarball prior running any code. So probably 'make dist' could generate it. Will see what's the best approach and let you know what I found.

added readme
Generate README automagically
@@ -14,3 +14,4 @@ webinject.pl
MANIFEST.bak
MYMETA.json
MYMETA.yml
README

This comment has been minimized.

@ambs

ambs Jan 26, 2016

Contributor

Be sure to ship README

@ambs

ambs Jan 26, 2016

Contributor

Be sure to ship README

@@ -24,6 +24,10 @@ requires 'URI' => 0;
install_script 'bin/webinject.pl';
if (!-f "README" || -M "lib/Webinject" < -M "README") {

This comment has been minimized.

@ambs

ambs Jan 26, 2016

Contributor

Generate README only if really necessary. Hopefully this would not be needed, but allows you to edit README before ship if you like. If not, I can just remove the if

@ambs

ambs Jan 26, 2016

Contributor

Generate README only if really necessary. Hopefully this would not be needed, but allows you to edit README before ship if you like. If not, I can just remove the if

sni added a commit that referenced this pull request Feb 1, 2016

@sni sni merged commit 401e423 into sni:master Feb 1, 2016

@sni

This comment has been minimized.

Show comment
Hide comment
@sni

sni Feb 1, 2016

Owner

thanks

Owner

sni commented Feb 1, 2016

thanks

@ambs

This comment has been minimized.

Show comment
Hide comment
@ambs

ambs Feb 1, 2016

Contributor

\o/

Contributor

ambs commented Feb 1, 2016

\o/

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