From 6bd008ec4118cee45706895d70d62fbba51c4bb2 Mon Sep 17 00:00:00 2001
From: Guewen Baconnier <guewen.baconnier@camptocamp.com>
Date: Fri, 10 Jan 2020 13:42:16 +0100
Subject: [PATCH] Add readme's source

---
 stock_cubiscan/__manifest__.py         | 1 +
 stock_cubiscan/readme/CONFIGURE.rst    | 4 ++++
 stock_cubiscan/readme/CONTRIBUTORS.rst | 1 +
 stock_cubiscan/readme/DESCRIPTION.rst  | 5 +++++
 stock_cubiscan/readme/ROADMAP.rst      | 3 +++
 stock_cubiscan/readme/USAGE.rst        | 5 +++++
 6 files changed, 19 insertions(+)
 create mode 100644 stock_cubiscan/readme/CONFIGURE.rst
 create mode 100644 stock_cubiscan/readme/CONTRIBUTORS.rst
 create mode 100644 stock_cubiscan/readme/DESCRIPTION.rst
 create mode 100644 stock_cubiscan/readme/ROADMAP.rst
 create mode 100644 stock_cubiscan/readme/USAGE.rst

diff --git a/stock_cubiscan/__manifest__.py b/stock_cubiscan/__manifest__.py
index 6afdff588..ddee1889d 100644
--- 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
new file mode 100644
index 000000000..f94238301
--- /dev/null
+++ 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
new file mode 100644
index 000000000..78f10eddd
--- /dev/null
+++ 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
new file mode 100644
index 000000000..984464fcb
--- /dev/null
+++ 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
new file mode 100644
index 000000000..e3e052ae0
--- /dev/null
+++ 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
new file mode 100644
index 000000000..aecdada67
--- /dev/null
+++ 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.