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

Add a README #24

Open
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
1 participant
@paultcochrane
Contributor

paultcochrane commented Jul 20, 2016

Having a README is very helpful for a GitHub project since markdown
formatted README files are automatically displayed on the landing page for
the given project and hence give a first impression and the first pieces of
information for a user interested in using or possibly contributing to the
project. Hence it is described in the README how to use the module as well
as how to install it from cpanm and from source. I know that a README is
automatically generated from Dist::Zilla, however there is no usage
or installation information, and nothing beats a hand-crafted document for
the first thing users are likely to see.

Add a README
Having a README is very helpful for a GitHub project since markdown
formatted README files are automatically displayed on the landing page for
the given project and hence give a first impression and the first pieces of
information for a user interested in using or possibly contributing to the
project.  Hence it is described in the README how to use the module as well
as how to install it from `cpanm` and from source.  I know that a README is
automatically generated from `Dist::Zilla`, however there is no usage
or installation information, and nothing beats a hand-crafted document for
the first thing users are likely to see.
@paultcochrane

This comment has been minimized.

Show comment
Hide comment
@paultcochrane

paultcochrane Jul 20, 2016

Contributor

As with all my PRs, this is intented to be helpful, and if there's anything I can do to improve it, please let me know and I'll resubmit the PR.

Contributor

paultcochrane commented Jul 20, 2016

As with all my PRs, this is intented to be helpful, and if there's anything I can do to improve it, please let me know and I'll resubmit the PR.

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