From bbe945bb70dd9af15eeef86805b198a1e718932a Mon Sep 17 00:00:00 2001
From: Anthony Geourjon <anthony.geourjon@tetras-libre.fr>
Date: Mon, 6 Mar 2023 17:43:26 +0100
Subject: [PATCH] Update README

---
 README.md | 32 +++++++++++++++++++++++++++-----
 1 file changed, 27 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 31b29ba..0b220b2 100644
--- a/README.md
+++ b/README.md
@@ -19,16 +19,38 @@ This readme assumes that you now a few basic about `docker` and `docker-compose`
 
 ### Install
 
-Clone the current git repository and cd inside.
+Clone the current git repository and cd inside. :
 
+```
+git clone gitlab@gitlab.tetras-libre.fr:iiif/POC-mirador.git
+```
 
-Copy `.env.template` to `.env` and change variables to suit your need.
+Copy example env file :
+```
+cp .env.template .env
+```
 
-You **MUST** set at least the `ANNOTOT_SECRET_KEY_BASE` to a random string, the rest is preconfigured for a local development environment.
+Build project :
+```
+docker-compose build
+```
+
+Run project (can be long)
+```
+docker-compose up
+```
+
+Project will be available at `http://localhost:$DEV_PORT` (default port is 9000).
 
-The `$HTTP_FOLDER` (`./www` by default) directory will be accessible via HTTP at `http://localhost:$PORT/data` and can be used to store manifests and theirs ressources and see them in Mirador.  
+Stop project
+```
+docker-compose down
+```
 
-Run `docker-compose up -d`, which will serve a mirador instance at `http://localhost:$DEV_PORT` (default port is 9000) with live rebuild/reload enabled on each `src/` and `public/` files modifications.
+#### Notes for .env file
+
+You **MUST** set at least the `ANNOTOT_SECRET_KEY_BASE` to a random string, the rest is preconfigured for a local development environment.
+The `$HTTP_FOLDER` (`./www` by default) directory will be accessible via HTTP at `http://localhost:$PORT/data` and can be used to store manifests and theirs ressources and see them in Mirador.
 
 ### Production
 
-- 
GitLab