OVERVIEW

This software code, written in the Perl programming language, <%SUMMARY OF MODULE IN 1/2 SENTENCE IN AS NON-TECHNICAL LANGUAGE AS POSSIBLE %> 

WHO IS IT FOR?

The target audience for this software is <% DESCRIBE WHO A TYPICAL USER MIGHT BE %> who is trying to <% DESCRIBE THE PROBLEM TRYING TO BE SOLVED %>

IS THIS SOFTWARE CURRENTLY MAINTAINED?

This software is in an <% EARLY|ACTIVE|INACTIVE %> state of development <% AND|BUT %> is considered to be <% EXPERIMENTAL|UNSTABLE|MATURE %>.

Bug reports are <% LARGELY IGNORED|ACTIVELY RESPONDED TO %>. To learn how to report bugs, see the BUG REPORTING section on the man page at <% LINK TO BUG REPORTING SECTION ON MAN PAGE %>

IS THIS SOFTWARE EASY TO USE?

<% OVERVIEW OF SKILLS & EXPERIENCE NEEDED OR EXPECTED %>

HOW DOES IT WORK?

Please see the man page at <% LINK TO MAN PAGE %> for how to use this software.

IS THIS PROJECT ACTIVELY LOOKING FOR HELP?

This project <% IS|IS NOT %> seeking assistance from other developers at this time. Pull requests and other contributions <% WILL|WILL NOT %> likely get ignored.

<% BULLET LIST AREAS WHERE PROJECT COULD NEED HELP HERE %>

Please consult the man page at <% LINK TO MAN PAGE AND OTHER RESOURCES %> if you would like to get involved.

HOW DO I GET IT INSTALLED?

Please, follow the instructions at <% LOCATION OF INSTALLATION GUIDE %>

OTHER INFO

Copyright, authorship, and basic license can go here.