From 6646ad281fde3e1206c1736aae403fbc3948855a Mon Sep 17 00:00:00 2001
From: Matthieu Bessat <spamfree@matthieubessat.fr>
Date: Mon, 3 Aug 2020 18:31:02 +0200
Subject: [PATCH] feat: README

---
 README.md    |  8 +++++++-
 README_fr.md | 15 +++++++++++++++
 2 files changed, 22 insertions(+), 1 deletion(-)
 create mode 100644 README_fr.md

diff --git a/README.md b/README.md
index 46bbf17..ed1652c 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,10 @@
 ## Requirements
 
 - Node.js >= 12.18.2
-- Yarn >= 1.17
+- Yarn >= 1.17 - [Installation Page](https://classic.yarnpkg.com/en/docs/install)
+- MongoDB >= v4.2.8
+- A SMTP server
+- A S3 Bucket
 
 ## Installation 
 
@@ -11,6 +14,9 @@ Before using the server you have to install all the packages required
 
 Use the `yarn install` command at the root (take a long time)
 
+Then you have to fill the `.env`. We advise you to copy and paste the `.env.example` file as a example for the real `.env`
+
+
 ## Usage in a development environment
 
 `yarn serve`
diff --git a/README_fr.md b/README_fr.md
new file mode 100644
index 0000000..b64792d
--- /dev/null
+++ b/README_fr.md
@@ -0,0 +1,15 @@
+## Démarrage du serveur (mode développement)
+
+Vous devez utiliser deux terminal simultanément ouvert à la racine
+
+Dans le premier terminal utilisez `yarn serve` afin de démarrer le serveur de développement
+
+Dans le deuxième terminal utilisez `yarn dev` afin de démarrer le compilateur TypeScript
+
+## Compilation du code afin de l'executer dans un environment de production
+
+A la racine, `yarn build && yarn assets`. Cette commande va d'une part compiler le code TypeScript en Node.js et d'une autre part éxecuter le script Gulp.js afin de générer les fichiers statiques adaptés à une utilisation en production.
+
+## Démarrage du serveur (mode production)
+
+Toujours à la racine utilisez la commande `yarn start` afin de démarer le serveur.