Maintainers
+Maintainers
This module is maintained by the OCA.
OCA, or the Odoo Community Association, is a nonprofit organization whose
diff --git a/agreement_stock/README.rst b/agreement_stock/README.rst
index 21cd7854..9a13d72d 100644
--- a/agreement_stock/README.rst
+++ b/agreement_stock/README.rst
@@ -1,21 +1,115 @@
-**This file is going to be generated by oca-gen-addon-readme.**
+=================
+Agreement - Stock
+=================
-*Manual changes will be overwritten.*
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ !! This file is generated by oca-gen-addon-readme !!
+ !! changes will be overwritten. !!
+ !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-Please provide content in the ``readme`` directory:
+.. |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-OCA%2Fcontract-lightgray.png?logo=github
+ :target: https://github.com/OCA/contract/tree/11.0/agreement_stock
+ :alt: OCA/contract
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+ :target: https://translation.odoo-community.org/projects/contract-11-0/contract-11-0-agreement_stock
+ :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+ :target: https://runbot.odoo-community.org/runbot/110/11.0
+ :alt: Try me on Runbot
-* **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)
+|badge1| |badge2| |badge3| |badge4| |badge5|
-Content of this README will also be drawn from the addon manifest,
-from keys such as name, authors, maintainers, development_status,
-and license.
+Odoo Agreement App does not provide an easy way to access stock transfers related to an agreement.
+Some organizations needs to have a quick access to stock transfers to track the performance of an agreement.
-A good, one sentence summary in the manifest is also highly recommended.
+This module allows you to link a transfer to an agreement and
+adds a smart button on the agreement to look at the list of related transfers.
+
+**Table of contents**
+
+.. contents::
+ :local:
+
+Usage
+=====
+
+To use this module, you need to:
+
+* Go to Inventory > Transfers
+* Select or create a transfer and set the agreement
+* Select or create a lot/serial number and set the agreement
+* Go to Agreement > Agreements
+* Open the previous agreement
+* Click on the smart button "Transfers" to see the list of related transfers
+* Click on the smart button "Stock Moves" to see the list of related stock moves
+* Click on the smart button "Lot/SN #" to see the list of related lot/serial numbers
+
+Known issues / Roadmap
+======================
+
+The roadmap of the Agreement application is documented on
+`Github Odoo Agreement App does not provide an easy way to access manufacturing orders
-related to an agreement. Some organizations needs to have a quick access to the
-production orders to track the performance of an agreement. This module allows you to link a manufacturing order to an agreement and
-adds a smart button on the agreement to look at the list of related MOs. Odoo Agreement App does not provide an easy way to access stock transfers related to an agreement.
+Some organizations needs to have a quick access to stock transfers to track the performance of an agreement. This module allows you to link a transfer to an agreement and
+adds a smart button on the agreement to look at the list of related transfers. Table of contents To install Field Service and have the mapping features,
-you need to install agreement and mrp Please refer to the installation instructions available at:
-https://github.com/OCA/contract/agreement_mrp To use this module, you need to: The roadmap of the Field Service application is documented on
-Github. The roadmap of the Agreement application is documented on
+Github. Bugs are tracked on GitHub 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. Do not contact contributors directly about support or help with technical issues. The development of this module has been financially supported by: This module is maintained by the OCA. OCA, or the Odoo Community Association, is a nonprofit organization whose
@@ -449,7 +444,7 @@ mission is to support the collaborative development of Odoo features and
promote its widespread use. Current maintainers: This module is part of the OCA/contract project on GitHub. This module is part of the OCA/contract project on GitHub. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.Agreement - MRP
+Agreement - Stock
-
-Installation
-Usage
+Usage
-
Known issues / Roadmap
-Known issues / Roadmap
+Bug Tracker
+Bug Tracker
Credits
+Credits
Other credits
+Other credits
Maintainers
+Maintainers