<h1 class="title">Module name</h1> <p><a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/jobiols/odoo-addons/tree/11.0/scaffold_module"><img alt="jobiols/odoo-addons" src="https://img.shields.io/badge/github-jobiols%2Fodoo--addons-lightgray.png?logo=github" /></a></p> <p>[ This file must be max 2-3 paragraphs, and is required. ]</p> <p>This module extends the functionality of ... to support ... and to allow you to ...</p> <p><strong>Table of contents</strong></p> <div class="contents local topic" id="contents"> <ul class="simple"> <li><a class="reference internal" href="#installation" id="id5">Installation</a></li> <li><a class="reference internal" href="#configuration" id="id6">Configuration</a></li> <li><a class="reference internal" href="#usage" id="id7">Usage</a></li> <li><a class="reference internal" href="#known-issues-roadmap" id="id8">Known issues / Roadmap</a></li> <li><a class="reference internal" href="#changelog" id="id9">Changelog</a><ul> <li><a class="reference internal" href="#x-y-z-yyyy-mm-dd" id="id10">11.0.x.y.z (YYYY-MM-DD)</a></li> <li><a class="reference internal" href="#id4" id="id11">11.0.x.y.z (YYYY-MM-DD)</a></li> </ul> </li> <li><a class="reference internal" href="#bug-tracker" id="id12">Bug Tracker</a></li> <li><a class="reference internal" href="#credits" id="id13">Credits</a><ul> <li><a class="reference internal" href="#authors" id="id14">Authors</a></li> <li><a class="reference internal" href="#contributors" id="id15">Contributors</a></li> <li><a class="reference internal" href="#other-credits" id="id16">Other credits</a></li> <li><a class="reference internal" href="#maintainers" id="id17">Maintainers</a></li> </ul> </li> </ul> </div> <a name="installation"></a> <h2><a class="toc-backref" href="#id5">Installation</a></h2> <dl class="docutils"> <dt>[ This file must only be present if there are very specific</dt> <dd>installation instructions, such as installing non-python dependencies. The audience is systems administrators. ]</dd> </dl> <p>To install this module, you need to:</p> <ol class="arabic simple"> <li>Do this ...</li> </ol> <a name="configuration"></a> <h2><a class="toc-backref" href="#id6">Configuration</a></h2> <dl class="docutils"> <dt>[ This file is optional, it should explain how to configure</dt> <dd>the module before using it; it is aimed at advanced users. ]</dd> </dl> <p>To configure this module, you need to:</p> <ol class="arabic simple"> <li>Go to ...</li> </ol> <div class="figure"> <img alt="alternative description" src="https://raw.githubusercontent.com/jobiols/odoo-addons/11.0/scaffold_module/static/description/image.png" style="width: 600px;" /> </div> <a name="usage"></a> <h2><a class="toc-backref" href="#id7">Usage</a></h2> <dl class="docutils"> <dt>[ This file must be present and contains the usage instructions</dt> <dd>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 &quot;quick start&quot; section). ]</dd> </dl> <p>To use this module, you need to:</p> <ol class="arabic simple"> <li>Go to ...</li> </ol> <a name="known-issues-roadmap"></a> <h2><a class="toc-backref" href="#id8">Known issues / Roadmap</a></h2> <dl class="docutils"> <dt>[ Enumerate known caveats and future potential improvements.</dt> <dd>It is mostly intended for end-users, and can also help potential new contributors discovering new features to implement. ]</dd> </dl> <ul class="simple"> <li>...</li> </ul> <a name="changelog"></a> <h2><a class="toc-backref" href="#id9">Changelog</a></h2> <dl class="docutils"> <dt>[ The change log. The goal of this file is to help readers</dt> <dd><p class="first">understand changes between version. The primary audience is end users and integrators. Purely technical changes such as code refactoring must not be mentioned here.</p> <p class="last">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. ]</p> </dd> </dl> <a name="x-y-z-yyyy-mm-dd"></a> <h3><a class="toc-backref" href="#id10">11.0.x.y.z (YYYY-MM-DD)</a></h3> <ul class="simple"> <li>[BREAKING] Breaking changes come first. (<a class="reference external" href="https://github.com/OCA/repo/issues/70">#70</a>)</li> <li>[ADD] New feature. (<a class="reference external" href="https://github.com/OCA/repo/issues/74">#74</a>)</li> <li>[FIX] Correct this. (<a class="reference external" href="https://github.com/OCA/repo/issues/71">#71</a>)</li> </ul> <a name="id4"></a> <h3><a class="toc-backref" href="#id11">11.0.x.y.z (YYYY-MM-DD)</a></h3> <ul class="simple"> <li>...</li> </ul> <a name="bug-tracker"></a> <h2><a class="toc-backref" href="#id12">Bug Tracker</a></h2> <p>Bugs are tracked on <a class="reference external" href="https://github.com/jobiols/odoo-addons/issues">GitHub Issues</a>. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed <a class="reference external" href="https://github.com/jobiols/odoo-addons/issues/new?body=module:%20scaffold_module%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p> <p>Do not contact contributors directly about support or help with technical issues.</p> <a name="credits"></a> <h2><a class="toc-backref" href="#id13">Credits</a></h2> <a name="authors"></a> <h3><a class="toc-backref" href="#id14">Authors</a></h3> <ul class="simple"> <li>&lt;AUTHOR(S)&gt;</li> </ul> <a name="contributors"></a> <h3><a class="toc-backref" href="#id15">Contributors</a></h3> <ul class="simple"> <li>Firstname Lastname &lt;<a class="reference external" href="mailto:email.address&#64;example.org">email.address&#64;example.org</a>&gt; (optional company website url)</li> <li>Second Person &lt;<a class="reference external" href="mailto:second.person&#64;example.org">second.person&#64;example.org</a>&gt; (optional company website url)</li> </ul> <a name="other-credits"></a> <h3><a class="toc-backref" href="#id16">Other credits</a></h3> <dl class="docutils"> <dt>[ This file is optional and contains additional credits, other than</dt> <dd>authors, contributors, and maintainers. ]</dd> </dl> <p>The development of this module has been financially supported by:</p> <ul class="simple"> <li>Company 1 name</li> <li>Company 2 name</li> </ul> <a name="maintainers"></a> <h3><a class="toc-backref" href="#id17">Maintainers</a></h3> <p>Current maintainer:</p> <p><a class="reference external" href="https://github.com/your-github-login"><img alt="your-github-login" src="https://github.com/your-github-login.png?size=40px" /></a></p> <p>This module is part of the <a class="reference external" href="https://github.com/jobiols/odoo-addons/tree/11.0/scaffold_module">jobiols/odoo-addons</a> project on GitHub.</p> <p>You are welcome to contribute.</p>