[IMP] mrp_production_hierarchy: README

mrp_production_hierarchy/README.rst

@@ -1,14 +1,38 @@
-.. image:: https://img.shields.io/badge/license-AGPL--3-blue.png
-   :target: https://www.gnu.org/licenses/agpl
-   :alt: License: AGPL-3
-
 ===========================
 Production Orders Hierarchy
 ===========================
 
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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%2Fmanufacture-lightgray.png?logo=github
+    :target: https://github.com/OCA/manufacture/tree/10.0/mrp_production_hierarchy
+    :alt: OCA/manufacture
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/manufacture-10-0/manufacture-10-0-mrp_production_hierarchy
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/129/10.0
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| |badge5| 
+
 This module allows to view the hierarchy of generated production orders
 when several levels of bill of materials are involved.
 
+**Table of contents**
+
+.. contents::
+   :local:
+
 Usage
 =====
 
@@ -24,10 +48,6 @@ Once saved, click on the 'Hierarchy' button at right:
 
 .. figure:: mrp_production_hierarchy/static/description/mrp_production_hierarchy_3.png
 
-.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
-   :alt: Try me on Runbot
-   :target: https://runbot.odoo-community.org/runbot/129/10.0
-
 Known issues / Roadmap
 ======================
 
@@ -36,37 +56,39 @@ Known issues / Roadmap
 Bug Tracker
 ===========
 
-Bugs are tracked on `GitHub Issues
-<https://github.com/OCA/manufacture/issues>`_. In case of trouble, please
-check there if your issue has already been reported. If you spotted it first,
-help us smash it by providing detailed and welcomed feedback.
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/manufacture/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 <https://github.com/OCA/manufacture/issues/new?body=module:%20mrp_production_hierarchy%0Aversion:%2010.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
 =======
 
-Images
-------
+Authors
+~~~~~~~
 
-* Odoo Community Association: `Icon <https://odoo-community.org/logo.png>`_.
+* ABF OSIELL
 
 Contributors
-------------
+~~~~~~~~~~~~
 
 * Sébastien Alix <sebastien.alix@osiell.com> (https://osiell.com)
 
-Do not contact contributors directly about support or help with technical issues.
+Maintainers
+~~~~~~~~~~~
 
-Maintainer
-----------
+This module is maintained by the OCA.
 
 .. image:: https://odoo-community.org/logo.png
    :alt: Odoo Community Association
    :target: https://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 https://odoo-community.org.
+This module is part of the `OCA/manufacture <https://github.com/OCA/manufacture/tree/10.0/mrp_production_hierarchy>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

mrp_production_hierarchy/readme/CONTRIBUTORS.rst

@@ -0,0 +1 @@
+* Sébastien Alix <sebastien.alix@osiell.com> (https://osiell.com)

mrp_production_hierarchy/readme/DESCRIPTION.rst

@@ -0,0 +1,2 @@
+This module allows to view the hierarchy of generated production orders
+when several levels of bill of materials are involved.

mrp_production_hierarchy/readme/ROADMAP.rst

@@ -0,0 +1 @@
+* Only new production orders will benefit from this feature, it is not compatible with existing orders.

mrp_production_hierarchy/readme/USAGE.rst

@@ -0,0 +1,11 @@
+Create a new production order (Manufacture / Operations / Manufacturing Orders)
+with a multi-levels nomenclatured product, and related products configured with
+'Manufacture' and 'Make To Order' routes:
+
+.. figure:: mrp_production_hierarchy/static/description/mrp_production_hierarchy_1.png
+
+Once saved, click on the 'Hierarchy' button at right:
+
+.. figure:: mrp_production_hierarchy/static/description/mrp_production_hierarchy_2.png
+
+.. figure:: mrp_production_hierarchy/static/description/mrp_production_hierarchy_3.png