[IMP] account_payment_partner: Improve README

account_payment_partner/README.rst

@@ -1,85 +1,21 @@
-.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
-    :alt: License: AGPL-3
+**This file is going to be generated by oca-gen-addon-readme.**
 
-=======================
-Account Payment Partner
-=======================
+*Manual changes will be overwritten.*
 
-This module adds severals fields :
+Please provide content in the ``readme`` directory:
 
-* the *Supplier Payment Mode* and *Customer Payment Mode* on Partners,
+* **DESCRIPTION.rst** (required)
+* INSTALL.rst (optional)
+* CONFIGURE.rst (optional)
+* **USAGE.rst** (optional, highly recommended)
+* DEVELOP.rst (optional)
+* ROADMAP.rst (optional)
+* HISTORY.rst (optional, recommended)
+* **CONTRIBUTORS.rst** (optional, highly recommended)
+* CREDITS.rst (optional)
 
-* the *Payment Mode* on Invoices.
+Content of this README will also be drawn from the addon manifest,
+from keys such as name, authors, maintainers, development_status,
+and license.
 
-On a Payment Order, in the wizard *Select Invoices to Pay*, the invoices will
-be filtered per Payment Mode.
-
-Installation
-============
-
-This module depends on :
-
-* account_payment_mode
-
-This module is part of the OCA/bank-payment suite.
-
-Configuration
-=============
-
-There is nothing to configure.
-
-Usage
-=====
-
-You are able to add a payment mode directly on a partner.
-This payment mode is automatically associated to the invoice related to the partner. This default value could be change in a draft invoice.
-When you create an payment order, only invoices related to chosen payment mode are displayed.
-Invoices without any payment mode are displayed to.
-
-.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
-   :alt: Try me on Runbot
-   :target: https://runbot.odoo-community.org/runbot/173/10.0
-
-Known issues / Roadmap
-======================
-
- * No known issues.
-
-Bug Tracker
-===========
-
-Bugs are tracked on `GitHub Issues
-<https://github.com/OCA/bank-payment/issues>`_. 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 feedback.
-
-Credits
-=======
-
-Contributors
-------------
-
-* Alexis de Lattre <alexis.delattre@akretion.com>
-* Raphaël Valyi
-* Stefan Rijnhart (Therp)
-* Alexandre Fayolle
-* Stéphane Bidoul <stephane.bidoul@acsone.eu>
-* Danimar Ribeiro
-* Angel Moya <angel.moya@domatix.com>
-* `Tecnativa <https://www.tecnativa.com>`_:
-
-  * Pedro M. Baeza
-  * Carlos Dauden
-
-Maintainer
-----------
-
-.. image:: http://odoo-community.org/logo.png
-   :alt: Odoo Community Association
-   :target: http://odoo-community.org
-
-This module is maintained by the OCA.
-
-OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.
-
-To contribute to this module, please visit http://odoo-community.org.
+A good, one sentence summary in the manifest is also highly recommended.

account_payment_partner/readme/CONTRIBUTORS.rst

@@ -0,0 +1,11 @@
+* Alexis de Lattre <alexis.delattre@akretion.com>
+* Raphaël Valyi
+* Stefan Rijnhart (Therp)
+* Alexandre Fayolle
+* Stéphane Bidoul <stephane.bidoul@acsone.eu>
+* Danimar Ribeiro
+* Angel Moya <angel.moya@domatix.com>
+* `Tecnativa <https://www.tecnativa.com>`_:
+
+  * Pedro M. Baeza
+  * Carlos Dauden

account_payment_partner/readme/DESCRIPTION.rst

@@ -0,0 +1,5 @@
+[ This file must be max 2-3 paragraphs, and is required. ]
+
+This module extends the functionality of ... to support ...
+and to allow you to ...
+

account_payment_partner/readme/HISTORY.rst

@@ -0,0 +1,15 @@
+[ 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. ]
+
+10.0.1.2.0 (2018-05-24)
+~~~~~~~~~~~~~~~~~~~~~~~
+
+* [IMP] Add options to show partner bank account in invoice report
+  (`#458 <https://github.com/OCA/bank-payment/issues/458>`_)

account_payment_partner/readme/USAGE.rst

@@ -0,0 +1,28 @@
+[ 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). ]
+
+This module adds severals fields :
+
+* the *Supplier Payment Mode* and *Customer Payment Mode* on Partners,
+
+* the *Payment Mode* on Invoices.
+
+* the *Show bank account* on Payment Mode.
+
+* the *# of digits for customer bank account* on Payment Mode.
+
+* the *Bank account from journals* on Payment Mode.
+
+On a Payment Order, in the wizard *Select Invoices to Pay*, the invoices will
+be filtered per Payment Mode.
+
+Allows to print in the invoice to which account number the payment
+(via SEPA direct debit) is going to be charged so the customer knows that
+information, but there are some customers that don't want that everyone
+looking at the invoice sees the full account number (and even GDPR can say a
+word about that), so that's the reason behind the several options.