MàJ documentation

README.md

@@ -1,21 +1,33 @@
-<div align="center">
+![Skizzle](docs/images/logo_text.png)
-    <img src="https://cdn.rawgit.com/matteodelabre/projet-cmi/master/docs/screenshots/03.png" alt="Capture d'écran du jeu" />
-    <h1>Skizzle</h1>
-</div>
 
-Arborescence :
+**Skizzle est un jeu inspiré des jeux de plateformes,** des jeux
+de réflexion et de coopération. Deux joueurs font évoluer leur
+balle à travers des niveaux en forme de courts casse-têtes. Ils
+doivent parvenir jusqu'à la ligne d'arrivée en exploitant les
+différents mécanismes physiques et objets particuliers qu'ils
+peuvent rencontrer.
 
-```
+## Cadre
-- docs : comptes-rendus, rapports et autres documents
-- res : ressources (textures, images, musique)
-- src : code source (.cpp)
-- include : en-têtes (.hpp)
-```
 
-Compilation :
+Le jeu a été développé dans le cadre du projet C.M.I. informatique
+annuel pour l'Université de Montpellier. Vous pouvez lire
+les différents rapports de suivi du projet dans le dossier
+`docs/rapports/`.
 
-```
+## Compilation
-$ cd projet-cmi
+
-$ cmake .
+Le jeu est codé en C++, utilise des fonctionnalités du
-$ make
+standard C++11 et requiert donc un compilateur récent.
-```
+Les librairies suivantes sont nécessaires :
+
+* [SFML](http://www.sfml-dev.org/download.php) ;
+* [SFGUI](http://sfgui.sfml-dev.de/download/) ;
+* [Boost Filesystem](http://www.boost.org/doc/libs/1_60_0/more/getting_started/index.html).
+
+Une fois les librairies installées, exécuter CMake dans
+le dossier du projet pour générer les fichiers de projet,
+puis effectuer la compilation.
+
+## Licence
+
+Tous droits réservés.