Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
Can I configure github to display readme document from the perldoc ? The module (.pm) was uploaded there, I just want github to make some output that was generated from e.g perldoc module.pm, automatically ( I shouldn’t be changing readme.md myself all the time)
Github would automatically handle a “README.pod” file, according to their documentation. Creating and maintaining README.pod is up to you. You could consider using some local automation tools to maintain it, if you don’t want to maintain it by hand.
There are some benefits to maintaining the README separately. For example, a Perl module’s POD usually doesn’t contain installation instructions, but those would be one of the first things you would expect to find in README file.