Readme template

Due to our heavy use of Github we use README.md files to take advantage of their markdown parsing on repository landing pages. The README files follow very similar conventions to the Drupal README.txt conventions found here.

README.md files should use this basic structure:

Islandora Example Module

Introduction

A brief introduction and summary of the module.

Requirements

This module requires the following modules/libraries:

• Islandora
• Tuque
• Any
• Additional
• Requirements

Installation

Install as usual, see this for further information.

Configuration

Set the paths for example and module in Administration » Islandora » MODULE (admin/islandora/module).

Include a screenshot of configuration page.

Troubleshooting/Issues

Having problems or solved a problem? Check out the Islandora google groups for a solution.

• Islandora Group
• Islandora Dev Group

FAQ

Q. Is this normal?

A. Yes. This is normal. Why ...

Maintainers/Sponsors

Current maintainers:

• Maintainer Name
• Another Maintainer

This project has been sponsored by:

• Some really awesome sponsor A description of this really awesome sponsor

Development

If you would like to contribute to this module, please check out our helpful Documentation for Developers info, as well as our Developers section on the Islandora.ca site.

Also include any Travis gotcha's here.

License

GPLv3