From cf4702aa02567797cccc6eaf929ca069f1574466 Mon Sep 17 00:00:00 2001
From: David Beniamine <david.beniamine@tetras-libre.fr>
Date: Tue, 14 Apr 2020 12:04:49 +0200
Subject: [PATCH] More doc + sample

---
 .env.sample |  3 +++
 Readme.md   | 14 ++++++++++++--
 2 files changed, 15 insertions(+), 2 deletions(-)
 create mode 100644 .env.sample

diff --git a/.env.sample b/.env.sample
new file mode 100644
index 0000000..5288e19
--- /dev/null
+++ b/.env.sample
@@ -0,0 +1,3 @@
+RESTART=no
+APP_DEBUG=false
+DEV_PORT=5000
diff --git a/Readme.md b/Readme.md
index 469192c..0ffffed 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,8 +1,18 @@
 # Unl2Rdf
+
 A serialization converter from the official UNL format to the proposed RDF-UNL format.
 
-This is a one page [flask](https://flask.palletsprojects.com) app to convert unl to rdf, the web app is full python, everything is in the file `src/app/app.py`.
+## How to use
 
-The display rendering uses the templates in the directory `src/app/templates` see [flakes templating](https://flask.palletsprojects.com/en/1.1.x/quickstart/#rendering-templates).
+```bash
+cp .env.sample .env
+docker-compose up
+```
+
+Then open in a browser `http://localhost:5000`
 
+## Developpement
 
+This is a one page [flask](https://flask.palletsprojects.com) app to convert unl to rdf, the web app is full python, everything is in the file `src/app/app.py`.
+
+The display rendering uses the templates in the directory `src/app/templates` see [flakes templating](https://flask.palletsprojects.com/en/1.1.x/quickstart/#rendering-templates).
-- 
GitLab