Merge branch '6-ecrire-le-fichier-readme-md' into 'develop'

README => DONE

Closes #6

See merge request !132

README.md

@@ -2,24 +2,18 @@
 
 ## Introduction
 
-AstroNomical Information System est un outil web générique qui vise à faciliter
-la mise à disposition de données (Astrophysiques), accessible depuis 
-une base de données, à une communauté de scientifiques.
+AstroNomical Information System, ou ANIS, est une suite d'outils web génériques qui visent à faciliter la mise à
+disposition de données astrophysiques, accessibles depuis une base de données, à une communauté de scientifiques.
 
-ANIS-CLIENT est un composant de la suite ANIS qui permet de visualiser les datasets dans un navigateur web.
-ANIS-CLIENT est capable de générer des formulaires et d'interroger une ou plusieurs bases de données 
-à partir des informations contenues dans la base de metamodel.
+ANIS-CLIENT est un composant de la suite ANIS qui permet de visualiser les datasets à travers un navigateur web.
+A partir des informations contenues dans la base de metamodel, ANIS-CLIENT est capable :
+- d'afficher la liste des datasets disponibles pour une instance donnée.
+- de générer un formulaire de recherche sur un dataset en sélectionnant des critères ainsi que les résultats à afficher.
+- de visualiser et télécharger les résultats de la recherche et informations associées.
+- d'afficher les informations détaillées d'un objet à travers des graphes ou des images par exemple.
 
-ANIS est protégée par la licence CeCILL (voir le fichier LICENCE à la racine).
+ANIS est protégée par la licence CeCILL (voir le fichier [LICENCE](LICENCE)).
 
-## Fonctionnalités
-
-ANIS-CLIENT permet de : 
-
-- Afficher la liste des datasets disponibles pour une instance donnée.
-- Faire une recherche sur un dataset en sélectionnant des critères ainsi que les résultats à afficher.
-- Visualiser et télécharger les résultats de la recherche et informations associées.
-- Afficher le détail d'un objet (graphe)
 
 ## Installation
 
@@ -32,6 +26,24 @@ Avant de commencer l'installation, assurez-vous d'avoir les commandes suivantes
 
 Une connexion internet sera nécessaire afin de télécharger les dépendances.
 
+### Installation et démarrage de l'application en mode développement
+
+ANIS-CLIENT contient un Makefile qui aide à l'installation et au démarrage de l'application.
+
+1. Pour installer l'application et ces dépendances, taper à la racine du projet :
+
+> make install
+ 
+2. Lancer l'application :
+
+> make start
+
+3. Stopper l'application :
+
+> make stop
+
+**Attention** : ANIS-CLIENT repose sur ANIS-SERVER pour fonctionner !
+
 ### Liste des commandes
 
 Le fichier `Makefile` situé à la racine du projet rend disponible une liste de commandes utiles à la gestion de
@@ -43,6 +55,12 @@ Pour voir la liste des commandes disponibles, ouvrir un terminal à la racine du
 
 **Attention** : ces commandes sont destinées à être utilisées en mode développement uniquement !
 
+### Mode production
+
+Pour compiler le projet pour de la production, il existe une commande make pour générer le dossier `dist` à la racine :
+
+> make build
+
 ## Technologies
 
 Voici une liste non exhaustive des principales dépendances utilisées lors du développement d'ANIS-CLIENT :
@@ -55,9 +73,8 @@ Voici une liste non exhaustive des principales dépendances utilisées lors du d
 * `GIT` : [http://git-scm.com](http://git-scm.com)
 * `CeCILL`: [http://www.cecill.info/index.en.html](http://www.cecill.info/index.en.html)
 
-## Auteurs
 
-Liste des personnes impliquées dans le projet :
+## Auteurs
 
 * `François Agneray` : Laboratoire d'Astrophysique de Marseille (CNRS)
 * `Chrystel Moreau` : Laboratoire d'Astrophysique de Marseille (CNRS)