From 0aad16b8da14caafe167a2d7737afff6f2dce62e Mon Sep 17 00:00:00 2001
From: Pedro Salgado <steenzout@ymail.com>
Date: Fri, 30 Dec 2016 16:41:46 -0700
Subject: [PATCH] HOWTO.md: added.

---
 HOWTO.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 HOWTO.md

diff --git a/HOWTO.md b/HOWTO.md
new file mode 100644
index 0000000..eac6777
--- /dev/null
+++ b/HOWTO.md
@@ -0,0 +1,39 @@
+# How-to
+
+This repo is structured the following way:
+
+- `${ODOO_VERSION}/`
+  - `base/`
+    - `Dockerfile`: file to build the `${ODOO_VERSION}-base` container image
+  - `${ODOO_RELEASE}/`
+    - `Dockerfile`: file to build the `${ODOO_VERSION}.${ODOO_RELEASE}` container image taking `${ODOO_VERSION}-base` as a base
+
+This repo contains a few bash scripts to
+help you generate docker container images.
+
+`generate.sh` will read the `${ODOO_VERSION}/releases.txt` file,
+parse the `release:checksum` lines and
+generate the `${ODOO_VERSION}/${ODOO_RELEASE}/Dockerfile`.
+
+```bash
+$ bash generate.sh
+```
+
+`build.sh` is used to build the docker container images locally.
+
+```bash
+$ bash build.sh
+```
+
+There are some auxiliary bash scripts to run docker container locally.
+
+```bash
+# start an Odoo release container
+$ bash start_container.sh 9.0 20161123
+
+# open interactive session on the Odoo container
+$ bash login.sh 9.0 20161123
+
+# stop and destroy
+$ bash stop_container.sh 9.0 20161123
+```