WIP: README

README.md

-# ANIS CLIENT
+# ANIS-CLIENT
 
 ## Introduction
 
@@ -6,11 +6,59 @@ AstroNomical Information System est un outil web générique qui vise à facilit
 la mise à disposition de données (Astrophysiques), accessible depuis 
 une base de données, à une communauté de scientifiques.
 
-ANIS-CLIENT est un composant de ANIS qui permet de visualiser les datasets dans un web browser.
+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 est protégée par la licence CeCILL (voir le fichier LICENCE à la racine).
+
+## 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
+
+### Prérequis
+
+Avant de commencer l'installation, assurez-vous d'avoir les commandes suivantes installées sur votre système :
+
+- `make`
+- `docker`
+
+Une connexion internet sera nécessaire afin de télécharger les dépendances.
+
+### Liste des commandes
+
+Le fichier `Makefile` situé à la racine du projet rend disponible une liste de commandes utiles à la gestion de
+l'application en mode développement.
+
+Pour voir la liste des commandes disponibles, ouvrir un terminal à la racine du projet et taper :
+
+> make
+
+**Attention** : ces commandes sont destinées à être utilisées en mode développement uniquement !
+
+## Technologies
+
+Voici une liste non exhaustive des principales dépendances utilisées lors du développement d'ANIS-CLIENT :
+
+* `Angular` : [https://angular.io](https://angular.io/)
+* `NGRX` : [https://ngrx.io](https://ngrx.io/)
+* `Bootstrap` : [https://getbootstrap.com](https://getbootstrap.com)
+* `D3.js` : [https://d3js.org](https://d3js.org)
+* `Docker` : [https://www.docker.com](https://www.docker.com)
+* `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 :
+
 * `François Agneray` : Laboratoire d'Astrophysique de Marseille (CNRS)
-* `Chrystel Moreau` : Laboratoire d'Astrophysique de Marseille (CNRS)
\ No newline at end of file
+* `Chrystel Moreau` : Laboratoire d'Astrophysique de Marseille (CNRS)
+* `Tifenn Guillas` : Laboratoire d'Astrophysique de Marseille (CNRS)
\ No newline at end of file