diff --git a/README.md b/README.md index 031d4a0..d1a5039 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,33 @@ -
- Capture d'écran du jeu -

Skizzle

-
+![Skizzle](docs/images/logo_text.png) -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. -``` -- docs : comptes-rendus, rapports et autres documents -- res : ressources (textures, images, musique) -- src : code source (.cpp) -- include : en-têtes (.hpp) -``` +## Cadre -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/`. -``` -$ cd projet-cmi -$ cmake . -$ make -``` +## Compilation + +Le jeu est codé en C++, utilise des fonctionnalités du +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. diff --git a/docs/images/logo_text.png b/docs/images/logo_text.png new file mode 100644 index 0000000..ea7a6fc Binary files /dev/null and b/docs/images/logo_text.png differ diff --git a/docs/images/01.png b/docs/images/screenshot_01.png similarity index 100% rename from docs/images/01.png rename to docs/images/screenshot_01.png diff --git a/docs/images/02.png b/docs/images/screenshot_02.png similarity index 100% rename from docs/images/02.png rename to docs/images/screenshot_02.png diff --git a/docs/images/03.png b/docs/images/screenshot_03.png similarity index 100% rename from docs/images/03.png rename to docs/images/screenshot_03.png