From 39885e6c6a3c41642f5653ee036f3b7e1bba2104 Mon Sep 17 00:00:00 2001
From: Bachir Soussi Chiadmi <bachir@figureslibres.io>
Date: Mon, 2 Mar 2020 17:11:14 +0100
Subject: [PATCH] readme

---
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)

diff --git a/README.md b/README.md
index 5100a5d..cb5a197 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,57 @@
 # offline-timeline-docker
 
+## Install docker (only once)
+```
+sudo pacman -S docker docker-compose docker-machine
+```
+
+## Clone this repos
+
+this will clone this repos (main docker environement) and necessary other source code (synopsx, webapp, xml-tei sources, vuejs client)
+
+```
+git clone --recursive https://esadhar.net/gogs/bachir/offline-timeline-docker.git
+```
+
+## Docker
+
+### start docker engine
+```
+sudo systemctl start docker
+```
+
+### build
+only before the first run (may take some time)
+```
+make build
+```
+### run
+then each time you want to launch the app
+```
+make upd
+```
+
+## Client
+open http://localhost:8988 in your browser
+
+## Vhost or Cross Origins Policy
+Cross origin poilicy will block the api requests from client
+You'll need to install vhost domain for api and client, like dev.gdp.net and dev.api.gdp.net
+Or in firefox install this addon to allow cors addons.mozilla.org/en-US/firefox/addon/cors-everywhere/
+
+## Logs
+to follow the webpack compilation process, run
+```
+make logs
+```
+
+## Update
+update the code
+```
+git pull origin master
+git pull --recurse-submodules
+```
+restart the containers
+```
+docker-compose restart app
+```