<p><strong>This file is going to be generated by oca-gen-addon-readme.</strong></p>
<p><em>Manual changes will be overwritten.</em></p>
<p>Please provide content in the <code>readme</code> directory:</p>
<ul class="simple">
<li><strong>DESCRIPTION.rst</strong> (required)</li>
<li>INSTALL.rst (optional)</li>
<li>CONFIGURE.rst (optional)</li>
<li><strong>USAGE.rst</strong> (optional, highly recommended)</li>
<li>DEVELOP.rst (optional)</li>
<li>ROADMAP.rst (optional)</li>
<li>HISTORY.rst (optional, recommended)</li>
<li><strong>CONTRIBUTORS.rst</strong> (optional, highly recommended)</li>
<li>CREDITS.rst (optional)</li>
</ul>
<p>Content of this README will also be drawn from the addon manifest,
from keys such as name, authors, maintainers, development_status,
and license.</p>
<p>A good, one sentence summary in the manifest is also highly recommended.</p>
<a name="automatic-changelog-generation"></a>
<h2>Automatic changelog generation</h2>
<p><cite>HISTORY.rst</cite> can be auto generated using <a class="reference external" href="https://pypi.org/project/towncrier">towncrier</a>.</p>
<p>Just put towncrier compatible changelog fragments into <cite>readme/newsfragments</cite>
and the changelog file will be automatically generated and updated when a new fragment is added.</p>
<p>Please refer to <cite>towncrier</cite> documentation to know more.</p>
<p>NOTE: the changelog will be automatically generated when using <cite>/ocabot merge $option</cite>.
If you need to run it manually, refer to <a class="reference external" href="https://github.com/OCA/maintainer-tools">OCA/maintainer-tools README</a>.</p>