[UPD] README.rst

2025-01-28 16:37:15 +02:00 · 2018-07-17 05:15:41 +02:00
parent 208a093f1a
commit fed91f1976
2 changed files with 583 additions and 16 deletions
--- a/mrp_multi_level/README.rst
+++ b/mrp_multi_level/README.rst
@@ -1,21 +1,124 @@
-**This file is going to be generated by oca-gen-addon-readme.**
+===============
+MRP Multi Level
+===============

-*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%2Fmanufacture-lightgray.png?logo=github
+    :target: https://github.com/OCA/manufacture/tree/11.0/mrp_multi_level
+    :alt: OCA/manufacture
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/manufacture-11-0/manufacture-11-0-mrp_multi_level
+    :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/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.
+This module allows you to calculate, based in known inventory, demand, and
+supply, and based on parameters set at product variant level, the new
+procurements for each product.

-A good, one sentence summary in the manifest is also highly recommended.
+To do this, the calculation starts at top level of the bill of material
+and explodes this down to the lowest level.
+
+Key Features
+------------
+
+* MRP parameters at product variant level.
+* Integration with `Stock Demand Estimates <https://github.com/OCA/stock-logistics-warehouse/tree/11.0/stock_demand_estimate>`_ system.
+* Cron job to calculate the MRP demand.
+* Manually calculate the MRP demand.
+* Confirm the calculated MRP demand and create PO's, or MO's.
+* Able to see the products for which action is needed.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Configuration
+=============
+
+* Go to *Manufacturing > MRP > MRP Area* and define or edit any existing area.
+  You can specify the working hours for every area.
+
+Usage
+=====
+
+To manually run the MRP scheduler:
+
+#. Go to *Manufacturing > MRP > Run MRP Multi Level*.
+#. On the wizard click *Run MRP*.
+
+To launch replenishment orders (moves, purchases, production orders...):
+
+#. Go to *Manufacturing > MRP > MRP Inventory*.
+#. Filter with *To procure*.
+#. Select multiple records and click on *Action > Procure* or click the right
+   hand side gears in any record.
+#. On the wizard, check everything is ok and click *Execute*.
+
+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 smashing it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/manufacture/issues/new?body=module:%20mrp_multi_level%0Aversion:%2011.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
+~~~~~~~
+
+* Ucamco
+* Eficent
+
+Contributors
+~~~~~~~~~~~~
+
+* Wim Audenaert <wim.audenaert@ucamco.com>
+* Jordi Ballester <jordi.ballester@eficent.com>
+* Lois Rilo <lois.rilo@eficent.com>
+
+Maintainers
+~~~~~~~~~~~
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+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.
+
+.. |maintainer-jbeficent| image:: https://github.com/jbeficent.png?size=40px
+    :target: https://github.com/jbeficent
+    :alt: jbeficent
+.. |maintainer-lreficent| image:: https://github.com/lreficent.png?size=40px
+    :target: https://github.com/lreficent
+    :alt: lreficent
+
+Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-jbeficent| |maintainer-lreficent| 
+
+This module is part of the `OCA/manufacture <https://github.com/OCA/manufacture/tree/11.0/mrp_multi_level>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.