[UPD] README.rst

pos_picking_delayed/README.rst

@@ -1,21 +1,129 @@
-**This file is going to be generated by oca-gen-addon-readme.**
+========================================
+Point of Sale - Picking Creation Delayed
+========================================
 
-*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%2Fpos-lightgray.png?logo=github
+    :target: https://github.com/OCA/pos/tree/10.0/pos_picking_delayed
+    :alt: OCA/pos
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/pos-10-0/pos-10-0-pos_picking_delayed
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/184/10.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 extends the functionality of odoo Point Of Sale to reduce creation
+time of the PoS orders, via the front UI.
 
-A good, one sentence summary in the manifest is also highly recommended.
+For that purpose, it delays the creation of the picking associated, that will
+be created later, by cron. (set by default to run each minute).
+
+Technical information
+---------------------
+
+A log will be generated to mention the creation of the pickings by cron.
+
+``2018-09-28 07:47:18,300 163 INFO db odoo.addons.base.ir.ir_cron: Starting job `Create Delayed PoS Picking.``
+
+``2018-09-28 07:47:19,168 163 INFO db odoo.addons.pos_picking_delayed.models.pos_order: Pickings created for 3 PoS Orders``
+
+This module is interesting specially in a context of Synchroneous Point Of
+Sale that is introduced by certification modules like 'l10n_fr_pos_cert' because
+in such cases, the bill will be printed only when the pos order is created (
+after the call of the function create_from_ui) and the creation of the picking
+is the process that takes the most time.
+
+See https://github.com/odoo/odoo/pull/26314#issuecomment-422949266
+for more information.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Configuration
+=============
+
+* Go to 'Point of Sale' / 'Configuration' / 'Point of Sale'
+* Select your Point of Sale
+* Set the value in the field 'Picking Creation Delayed'. (Checked by default)
+
+.. image:: https://raw.githubusercontent.com/pos_picking_delayed/static/description/pos_config_form.png
+
+Usage
+=====
+
+* Use your Point of Sale as usual. when validating an order, the order will
+  be in a different color until the cron is executed
+
+.. image:: https://raw.githubusercontent.com/pos_picking_delayed/static/description/pos_order_tree.png
+
+Known issues / Roadmap
+======================
+
+* Make this module depend on the module OCA `queue_job` job module.
+
+* In the cron job (or the future queue job), improvment can be done, limiting
+  the quantity of environments, grouping orders by company, and changing
+  context once.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/pos/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/pos/issues/new?body=module:%20pos_picking_delayed%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
+=======
+
+Authors
+~~~~~~~
+
+* GRAP
+
+Contributors
+~~~~~~~~~~~~
+
+* Sylvain LE GAL <https://twitter.com/legalsylvain>
+
+Other credits
+~~~~~~~~~~~~~
+
+The development of this module has been financially supported by:
+
+* GRAP, Groupement Régional Alimentaire de Proximité (www.grap.coop)
+* Mind & Go, (https://mind-and-go.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.
+
+This module is part of the `OCA/pos <https://github.com/OCA/pos/tree/10.0/pos_picking_delayed>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.