forked from alxp/islandora
-
Notifications
You must be signed in to change notification settings - Fork 118
Readme template
Nick Ruest edited this page Aug 23, 2015
·
8 revisions
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.
README.md files should use this basic structure:
# Islandora Example Module [![Build Status](https://travis-ci.org/Islandora/islandora_example_module.png?branch=7.x)](https://travis-ci.org/Islandora/islandora_example_module)
## Introduction
A brief introduction and summary of the module.
## Requirements
This module requires the following modules/libraries:
* [Islandora](https://github.com/islandora/islandora)
* [Tuque](https://github.com/islandora/tuque)
* Any
* Additional
* Requirements
## Installation
Install as usual, see [this](https://drupal.org/documentation/install/modules-themes/modules-7) 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](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora)
* [Islandora Dev Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora-dev)
## FAQ
Q. Is this normal?
A. Yes. This is normal. Why ...
## Maintainers/Sponsors
Current maintainers:
* [Maintainer Name](https://github.com/maintainer_github)
* [Another Maintainer](https://github.com/maintainer_github)
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 [CONTRIBUTING.md](CONTRIBUTING.md). In addition, we have helpful [Documentation for Developers](https://github.com/Islandora/islandora/wiki#wiki-documentation-for-developers) info, as well as our [Developers](http://islandora.ca/developers) section on the Islandora.ca site.
Also include any Travis gotcha's here.
## License
[GPLv3](http://www.gnu.org/licenses/gpl-3.0.txt)
You may be looking for the islandora-community wiki · new to islandora? · community calendar · interest groups