Add readme's source

OCA · Jan 10, 2020 · e7f58dc · e7f58dc
1 parent 67dd54c
commit e7f58dc
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 0 deletions.
diff --git a/stock_cubiscan/__manifest__.py b/stock_cubiscan/__manifest__.py
@@ -23,4 +23,5 @@
         "security/ir.model.access.csv",
     ],
     "installable": True,
+    "development_status": "Alpha",
 }
diff --git a/stock_cubiscan/readme/CONFIGURE.rst b/stock_cubiscan/readme/CONFIGURE.rst
@@ -0,0 +1,4 @@
+The first step is to configure the Packaging Types (Pallet, Box, ...) in Inventory > Configuration > Product Packaging Types.
+
+Configure the Cubiscan device in Inventory > Configuration > Cubiscan Devices.
+Use the "Test Device" to check the connection with the hardware.
diff --git a/stock_cubiscan/readme/CONTRIBUTORS.rst b/stock_cubiscan/readme/CONTRIBUTORS.rst
@@ -0,0 +1 @@
+* Patrick Tombez <patrick.tombez@camptocamp.com>
diff --git a/stock_cubiscan/readme/DESCRIPTION.rst b/stock_cubiscan/readme/DESCRIPTION.rst
@@ -0,0 +1,5 @@
+Cubiscan_ are dimensioners for cubing and weighing in warehouses.
+This module implements the communication with the dimensioners as well
+as a screen to measure and weight packaging of the products.
+
+.. _Cubiscan: https://cubiscan.com/
diff --git a/stock_cubiscan/readme/ROADMAP.rst b/stock_cubiscan/readme/ROADMAP.rst
@@ -0,0 +1,3 @@
+* The UI could get some improvements
+* Being able to open the Cubiscan screen from a product would be nice
+* The wizard should allow to set weight and size for a single unit in addition to the packaging
diff --git a/stock_cubiscan/readme/USAGE.rst b/stock_cubiscan/readme/USAGE.rst
@@ -0,0 +1,5 @@
+Use the "Wizard" button on a Cubiscan device to open the screen and take
+measurements.
+
+For developers: a script in the directory ``scripts/cubiscan_stub.py`` allows
+to simulate a Cubiscan server and send random measurements.