add basic documentation

README

@@ -0,0 +1,54 @@
+Publik iMio Industrialisation
+=============================
+
+Usage:
+
+  sudo -u hobo hobo-manage imio_indus_deploy -d $tenant --directory /path/to/directory/
+
+  (or without -d $tenant to get interactive choice)
+
+
+Expected directory layout
+-------------------------
+
+* blocks: list of w.c.s. blocks (XML files)
+* carddefs: list of w.c.s. cards (XML files)
+* category: list of w.c.s. categories (XML files)
+* datasources: list of w.c.s. data sources (XML files)
+* forms: list of w.c.s. forms (XML files)
+* workflows: list of w.c.s. workflows (XML files)
+* wscalls: list of w.c.s. webservice calls (XML files)
+
+* combo: list of portal file exports, they should be named portal-agent.json
+  and portal-user.json. (It actually takes files according to the template_name
+  associated to the service)
+
+* passerelle: list of connector file exports (JSON files).
+
+* roles: a single roles.json file, in authentic format, ex:
+
+  {
+    "roles": [
+      {
+        "name": "Parent",
+        "slug": "parent",
+        "ou": {"slug": "default"}
+      },
+      {
+        "name": "Agents traitants - Portail parent",
+        "slug": "agents-traitants-portail-parent",
+        "ou": {"slug": "default"}
+      }
+    ]
+  }
+
+
+Order of operations
+-------------------
+
+* Check roles
+* Deploy roles if they were missing
+* Wait for roles to be deployed to modules (using rabbitmq)
+* Deploy w.c.s. components (contents is overwritten except some form options)
+* Deploy combo components
+* Deploy passerelle components