Use Cases / Context

[ This file is optional but strongly suggested to allow end-users to evaluate the module's usefulness in their context. ]

It should explain the “why” of the module:

• in which context or use cases this module can be useful (practical examples are welcome!).
• what is the business requirement that generated the need to develop this module

It can also inform on related modules:

• modules it depends on and their features
• other modules that can work well together with this one
• suggested setups where the module is useful (eg: multicompany, multi-website)

Installation

[ This file must only be present if there are very specific installation instructions, such as installing non-python dependencies. The audience is systems administrators. ]

To install this module, you need to:

1. Do this ...

Configuration

[ This file is optional, it should explain how to configure the module before using it; it is aimed at advanced users. ]

To configure this module, you need to:

• Go to ...

||../static/description/image.png)

Usage

[ This file must be present and contains the usage instructions for end-users. As all other rst files included in the README, it MUST NOT contain reStructuredText sections only body text (paragraphs, lists, tables, etc). Should you need a more elaborate structure to explain the addon, please create a Sphinx documentation (which may include this file as a "quick start" section). ]

To use this module, you need to:

1. Go to ...

Known issues / Roadmap

[ Enumerate known caveats and future potential improvements. It is mostly intended for end-users, and can also help potential new contributors discovering new features to implement. ]

...

Changelog

[ The change log. The goal of this file is to help readers understand changes between version. The primary audience is end users and integrators. Purely technical changes such as code refactoring must not be mentioned here.

This file may contain ONE level of section titles, underlined with the ~ (tilde) character. Other section markers are forbidden and will likely break the structure of the README.rst or other documents where this fragment is included. ]

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits