This is an example of how a README.rst should look like:
===================== collective.fancystuff ===================== collective.fancystuff will make your Plone site more fancy. It can do cool things, and will make the task of keeping your site fancy a lot easier. The main audience for this are people who run a chocolate factory. But it also is useful for organizations planning on world domination. Features ======== - Be awesome - Make things fancier - Works out of the box, but can also be customized. After installation, you will find a new item in your site control panel where to set various options. Examples ======== This add-on can be seen in action at the following sites: - http://fancysite.com - http://fluffystuff.org Documentation ============= Full documentation for end users can be found in the "docs" folder. It is also available online at https://5.docs.plone.org/foo/bar Translations ============ This product has been translated into - German Installation ============ Install collective.fancystuff by adding it to your buildout: [buildout] ... eggs = collective.fancystuff and then running "bin/buildout" Contribute ========== - Issue Tracker: https://github.com/collective/collective.fancystuff/issues - Source Code: https://github.com/collective/collective.fancystuff - Documentation: https://5.docs.plone.org/foo/bar Support ======= If you are having issues, please let us know. We have a mailing list located at: firstname.lastname@example.org License ======= The project is licensed under the GPLv2.