Amélioration de la documentation notamment concernant la compilation

README.md

@@ -14,19 +14,17 @@ annuel pour l'Université de Montpellier. Vous pouvez lire
 les différents rapports de suivi du projet dans le dossier
 `docs/rapports/`.
 
-## Compilation
+## Installation et utilisation
 
-Le jeu est codé en C++, utilise des fonctionnalités du
+Le jeu est compatible avec la plupart des systèmes d'exploitation
-standard C++11 et requiert donc un compilateur récent.
+courants, notamment Windows, Mac OS X et Linux. Comme
-Les librairies suivantes sont nécessaires :
+le jeu n'est pas encore arrivé à une version stable, nous ne
+fournissons pas de version précompilée.
 
-* [SFML](http://www.sfml-dev.org/download.php) ;
+Pour compiler manuellement le jeu, des instructions détaillées
-* [SFGUI](http://sfgui.sfml-dev.de/download/) ;
+sont disponibles.
-* [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
+* [Guide pour Linux.](docs/guides/compilation-linux.md)
-le dossier du projet pour générer les fichiers de projet,
-puis effectuer la compilation.
 
 ## Licence
 

docs/Instructions

@@ -1,24 +0,0 @@
-* Installer CMake
-
-* Télécharger boost_1_60_0.tar.bz2
-https://sourceforge.net/projects/boost/files/latest/download?source=files
-- Ouvrir le terminal
-- cd ~/Téléchargements
-- tar --bzip2 -xf boost_1_60_0.tar.bz2
-- cd boost_1_60_0
-- sudo ./bootstrap.sh --with-libraries=filesystem
-- sudo ./b2 install 
-
-* Compilation : cmake .
-		make
-
-Concernant les commandes de l'éditeur :
-- pour changer la polarité d'un objet : Ctrl+scroll
-- tout sélectionner : ctrl+A
-- placer plusieurs objets : clic+déplacement de la souris
-- supprimer des objets : clic droit ou sélection + suppr
-- sélectionner plusieurs objets : alt+clic+déplacement de la souris
-
-
-
-

docs/guides/compilation-linux.md

@@ -0,0 +1,94 @@
+# Compiler le projet sur Linux
+
+## Debian, Ubuntu et dérivés
+
+### Installation des outils de compilation
+
+Cette commande installe les outils nécessaires au développement sur les
+systèmes Debian. Il est probable que ces outils soient déjà installés.
+Si cette commande renvoie une erreur, renseignez-vous sur les paquets
+de développement pour votre système.
+
+```sh
+$ sudo apt-get install build-essential cmake
+```
+
+### Installation de SFML
+
+La librairie SFML est déjà packagée pour la plupart des systèmes dérivés
+de Debian, notamment Ubuntu. Si la version est trop vieille (< \ 2.3.2), vous
+devrez la compiler vous mêmes.
+
+```sh
+$ sudo apt-get install libsfml-dev
+```
+
+### Installation de SFGUI
+
+Il n'existe pas de paquet SFGUI déjà préparé, il faut donc télécharger
+les sources et les compiler. *Conseil :* pour éviter de fausses manipulations,
+placez vous dans un dossier ne contenant pas de données importantes
+comme votre dossier de téléchargements pour effectuer ces commandes.
+
+```sh
+wget -O SFGUI.tar.gz $(curl -s https://api.github.com/repos/TankOs/SFGUI/releases | grep tarball_url | head -n 1 | cut -d '"' -f 4)
+mkdir SFGUI
+tar -zxf SFGUI.tar.gz -C SFGUI --strip-components=1
+cd SFGUI
+cmake .
+make
+sudo make install
+```
+
+Vous pouvez supprimer l'archive `SFGUI.tar.gz` et le dossier `SFGUI`
+si vous n'en avez plus besoin.
+
+```sh
+rm -r SFGUI.tar.gz SFGUI
+
+```
+### Installation de Boost
+
+Comme nous n'avons besoin que d'une petite partie de Boost, et vu
+la taille de la librairie Boost entière, il est plus sage de
+l'installer manuellement pour pouvoir spécifier les parties qui
+nous sont nécessaires. Si vous avez déjà installé les librairies
+`system` et `filesystem` de Boost sur votre machine, vous pouvez
+sauter cette étape. *Conseil :* pour éviter de fausses manipulations,
+placez vous dans un dossier ne contenant pas de données importantes
+comme votre dossier de téléchargements pour effectuer ces commandes.
+
+```sh
+wget -O boost.tar.bz2 https://sourceforge.net/projects/boost/files/latest/download
+mkdir boost
+tar -jxf boost.tar.bz2 -C boost --strip-components=1
+cd boost
+./bootstrap.sh --with-libraries=system,filesystem
+sudo ./b2 install
+```
+
+Vous pouvez supprimer l'archive `boost.tar.bz2` et le dossier `boost`
+si vous n'en avez plus besoin.
+
+```sh
+rm -r boost.tar.bz2 boost
+```
+
+### Compilation du projet
+
+Toutes les dépendances nécessaires étant installées, vous
+pouvez maintenant télécharger le code source du projet et
+le compiler.
+
+```sh
+wget -O skizzle.tar.gz https://github.com/matteodelabre/projet-cmi/archive/master.tar.gz
+mkdir skizzle
+tar -zxf skizzle.tar.gz -C skizzle --strip-components=1
+cd skizzle
+cmake .
+make
+./skizzle
+```
+
+Et voilà ! :smiley:
+