Standard readme template for my python packages

README.md

PROGRAM_NAME (used as 'executable-name')

This program does XYZ.

This program supports ABC.

Additional features include 123.

Installation

Download the files and install locally with pip. Requires Python 3 and the click package (this should be installed automatically because it's a required package).

pip install .

Once installed, run NAME -h or NAME --help in the terminal for usage instructions.

Usage

This is what the help screen shows.

TERMINAL USAGE OUTPUT HERE

Examples

Using the sample files, an example is:

EXAMPLE

This example does a thing.

Notes

• Does x.
• Has y.
• Default w is z.

To-do

• List stuff here.