From 5248c9dc2e650186ad8d94607e3ca17d852ee14e Mon Sep 17 00:00:00 2001
From: Maurane GLAUDE <mauranne.glaude_externe@rte-france.com>
Date: Tue, 16 Jul 2024 10:24:03 +0200
Subject: [PATCH] docs: update documentation

---
 README.md        | 60 +++++++++++++++++++++++++++++++++++++++++-------
 docs/overview.md |  6 +----
 2 files changed, 53 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 7d83727..04f8c09 100644
--- a/README.md
+++ b/README.md
@@ -3,17 +3,61 @@
 [![PyPI - Version](https://img.shields.io/pypi/v/antares-study-version.svg)](https://pypi.org/project/antares-study-version)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/antares-study-version.svg)](https://pypi.org/project/antares-study-version)
 
-![antares-web-installer-title.jpeg](docs/assets/antares-web-installer-title.png)
-
 Python application to install Antares Web Desktop on your local machine.
 
 -----
 
 **Table of Contents**
 
-- [overview](docs/overview.md)
-- [installation](docs/installation.md)
-- [usage](docs/usage.md)
-- [development](docs/development.md)
-- [Changelog](docs/CHANGELOG.md)
-- [LICENSE](LICENSE.md)
+- [Overview](README.md#Overview)
+- [Installation](README.md#Installation)
+- [Usage](README.md#usage)
+
+## Overview
+
+Antares Web Installer allows you to install the Desktop version of Antares Web on your local machine.
+The application updates the configuration files, installs an up-to-date version of
+the [AntaREST](https://github.com/AntaresSimulatorTeam/AntaREST/releases/latest) server
+and [Antares Solver](https://github.com/AntaresSimulatorTeam/Antares_Simulator/releases).
+The installer optionally may create a launcher shortcut on the desktop and open the web interface.
+
+The application is available for Windows and Ubuntu in both cli and gui version.
+
+
+## Installation
+
+Download the latest release on the [installer repository](https://github.com/AntaresSimulatorTeam/antares-web-installer/releases/latest/) depending on your os.
+
+
+## Usage
+
+### Graphic User Interface (GUI)
+
+Make sure the installer is located in an Antares Web package. 
+Double-click on the installer and follow the instructions.
+
+### Command line version (CLI)
+
+Open a new command prompt.
+
+Make sure you are in the directory containing the installer. Run the following command:
+```
+AntaresWebInstaller[.exe] -s <SOURCE_DIR> -t <TARGET_DIR>
+```
+
+If the installer is located in the new Antares Web Desktop directory, run:
+
+```
+AntaresWebInstaller[.exe] -t <TARGET_DIR>
+```
+
+where `<TARGET_DIR>` is the directory where you want to install the Antares Web Desktop and `<SOURCE_DIR>`
+the directory to copy files from. Add `.exe` if you use the installer on Windows.
+
+Note that you can specify an existing directory as value of `TARGET_DIR`, in which case the installer will update the
+existing installation.
+
+By default, the installer will generate shortcuts and launch the server at the end of the installation, but you
+optionally can decide to deactivate these steps with `--no-shortcut` and `--no-launch`.
+
+Run ```AntaresWebInstaller[.exe] --help``` for more options.
diff --git a/docs/overview.md b/docs/overview.md
index 4049dc7..1ac6ece 100644
--- a/docs/overview.md
+++ b/docs/overview.md
@@ -12,11 +12,9 @@ d'[Antares Solver](https://github.com/AntaresSimulatorTeam/Antares_Simulator/rel
 Le programme d'installation peut, sur demande, ajouter des raccourcis sur le bureau pour lancer le serveur et ouvrir
 l'interface web.
 
-L'application `antares-web-installer` existe uniquement en ligne de commande : `AntaresWebInstaller.exe`.
-
 L'application est disponible pour Windows et Ubuntu.
 
-## Presentation (EN)
+## Overview (EN)
 
 This application allows you to install the Desktop version of Antares Web on your local machine.
 The application updates the configuration files of the application, installs an up-to-date version of
@@ -24,6 +22,4 @@ the [AntaREST](https://github.com/AntaresSimulatorTeam/AntaREST/releases/latest)
 and [Antares Solver](https://github.com/AntaresSimulatorTeam/Antares_Simulator/releases).
 The installer can, on request, add shortcuts to the desktop to launch the server and open the web interface.
 
-The `antares-web-installer` application exists only in command line interface (cli): `AntaresWebInstaller.exe`.
-
 The application is available for Windows and Ubuntu.