forked from alxp/islandora
-
Notifications
You must be signed in to change notification settings - Fork 118
Readme template
DannyJoris edited this page Feb 15, 2013
·
8 revisions
Place the text in a file named README.txt in the root of your module. Try to document the module as detailed as possible. The titles are only suggestions, so remove any you don't use.
CONTENTS OF THIS FILE
---------------------
* summary
* requirements
* installation
* configuration
* customization
* troubleshooting
* faq
* contact
* sponsors
SUMMARY
-------
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec pulvinar volutpat
mi, in vestibulum lorem posuere vitae. Donec a feugiat elit. Cras faucibus
volutpat quam non ornare. Ut ultrices, nisl eget tincidunt iaculis, orci nisi
sagittis nisi, vitae ullamcorper justo eros sed felis. Etiam et dui in risus
placerat eleifend at sit amet orci. In pellentesque nisi vel sem volutpat vitae
euismod purus tincidunt. Cras auctor gravida est, laoreet ultricies cursus id.
List example:
* Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Donec pulvinar volutpat mi, in vestibulum lorem posuere vitae.
* Donec a feugiat elit.
Cras faucibus volutpat quam non ornare.
REQUIREMENTS
------------
INSTALLATION
------------
CONFIGURATION
-------------
CUSTOMIZATION
-------------
TROUBLESHOOTING
---------------
F.A.Q.
------
CONTACT
-------
SPONSORS
--------
You may be looking for the islandora-community wiki · new to islandora? · community calendar · interest groups