add readme

account_offbalance_sponsorship/README.rst

@@ -0,0 +1,68 @@
+==================================
+Off balance sponsorship accounting
+==================================
+
+..
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:eb5f5892e8010671bcfb91746ecfef8a321631e5d4e9671fdbe069f42e30c369
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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-CompassionCH%2Ftest--repo-lightgray.png?logo=github
+    :target: https://github.com/CompassionCH/test-repo/tree/14.0/account_statement_completion
+    :alt: CompassionCH/test-repo
+
+|badge1| |badge2| |badge3|
+
+This module adds a way to implement off-balance sponsorship accounting.
+Sponsorship generate invoices to enable off balance accounting (which can be required in certain legislation)
+we cannot rely on the odoo off-balance account feature (it does not allow a reconcilable account)
+2 accounts are defined in the sponsorship config: Account asset and an reconcilable account.
+This enable to have the full set of accounts from invoice generation to payment, all off the main chart of account.
+
+The income to be reported in the accounting is to be done in batch, once payments are in.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/CompassionCH/test-repo/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/CompassionCH/test-repo/issues/new?body=module:%20account_statement_completion%0Aversion:%2014.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
+-------
+
+* Compassion CH
+
+Contributors
+------------
+
+-  Steve Ferry <[email protected]>
+-  Emanuel Cino <[email protected]>
+-  Quentin Gigon <[email protected]>
+
+Maintainers
+-----------
+
+This module is part of the `CompassionCH/test-repo <https://github.com/CompassionCH/test-repo/tree/14.0/account_statement_completion>`_ project on GitHub.
+
+You are welcome to contribute.