[IMP] l10n_br_sale_report_py3o: Add readme.

l10n_br_sale_report_py3o/README.rst

@@ -2,22 +2,84 @@
 L10n Br Sale Report Py3o
 ========================
 
-KMEE
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:33e2e3fa7d304fe95c806409ae73e25636b1886ff025195e0158e3f54f7306e7
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-KMEE%2Fkmee--odoo--addons-lightgray.png?logo=github
+    :target: https://github.com/KMEE/kmee-odoo-addons/tree/16.0/l10n_br_sale_report_py3o
+    :alt: KMEE/kmee-odoo-addons
+
+|badge1| |badge2| |badge3|
+
+Contains the sale order report in py3o format.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Use Cases / Context
+===================
+
+Some customers want to have a customized sales order report, and the
+ability to edit the layout whenever they want.
 
 Configuration
 =============
 
 To configure this module, you need to:
 
-#. Go to ...
+1. Go to \*Settings > Technical > Reporting > Py3o Templates.
+2. Create a template by defining a name and uploading the ODT file.
+3. Go to \*Settings > Technical > Reporting > Reports.
+4. Search for "Quotation / Order py3o".
+5. In the Template field, choose the template created previously.
 
 Usage
 =====
 
 To use this module, you need to:
 
-#. Go to ...
+1. Go to \*Sale.
+2. Within a sale order, click on \*Print > Quotation / Order py3o.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/KMEE/kmee-odoo-addons/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 <https://github.com/KMEE/kmee-odoo-addons/issues/new?body=module:%20l10n_br_sale_report_py3o%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+-------
+
+* KMEE
+
+Contributors
+------------
+
+-  Tiago Amaral [email protected]
+
+Maintainers
+-----------
 
+This module is part of the `KMEE/kmee-odoo-addons <https://github.com/KMEE/kmee-odoo-addons/tree/16.0/l10n_br_sale_report_py3o>`_ project on GitHub.
 
-Changelog
-=========
+You are welcome to contribute.

l10n_br_sale_report_py3o/readme/CONFIGURE.md

@@ -0,0 +1,7 @@
+To configure this module, you need to:
+
+1. Go to *Settings > Technical > Reporting > Py3o Templates.
+2. Create a template by defining a name and uploading the ODT file.
+3. Go to *Settings > Technical > Reporting > Reports.
+4. Search for "Quotation / Order py3o".
+5. In the Template field, choose the template created previously.

l10n_br_sale_report_py3o/readme/CONTEXT.md

@@ -0,0 +1 @@
+Some customers want to have a customized sales order report, and the ability to edit the layout whenever they want.

l10n_br_sale_report_py3o/readme/CONTRIBUTORS.md

@@ -0,0 +1 @@
+- Tiago Amaral <[email protected]>

l10n_br_sale_report_py3o/readme/DESCRIPTION.md

@@ -0,0 +1 @@
+Contains the sale order report in py3o format.

l10n_br_sale_report_py3o/readme/USAGE.md

@@ -0,0 +1,4 @@
+To use this module, you need to:
+
+1. Go to *Sale.
+2. Within a sale order, click on *Print > Quotation / Order py3o.