final2

README.md

@@ -7,8 +7,18 @@ Pour voir le résultat de l'exécution du script, il faut aller sur la forge dan
 
 # Module Image, UE LIFAPCD
 ## Contributeurs et License
+- VWALUMA Jean Marc p2108190
+- BECHANI Yasser p2100684
+- BRENNER Remy p1809115
 ## Pour compiler
+- Pour compiler placez vous dans le repertoire du projet (dans un terminal) et tapez la commande "make"
+- Pour executer tapez soit "bin/exemple" soit "bin/test" soit "bin/affichage" depuis un terminal
 ## Les fichiers
+- Dans le repertoire src vous trouverez les fichiers .cpp et .h
+- Dans le repertoire obj vous trouverez les fichiers objets de chacun des .cpp
+- Dans le repertoire bin vous trouverez 3 executables permetant de tester le module image. 
+- Dans le repertoire data vous trouverez les images sauvées et lues.
+- Dans le repertoire doc vous trouverez la documentation.
 ## Bugs
 - Lors du premier test des fonctions "sauver" et "ouvrir" le repertoire "data" n'existait pas.
 - Les coordonnées des pixels de l'image sauvé ne sont pas corrects, ils sont divisés par deux.

src/ImageViewer.h

@@ -6,7 +6,6 @@
 
 /**
  * @class ImageViewer
- *
  * @brief La classe ImageViewer permettant d'afficher une image avec SDL2.
  *
  */
@@ -34,10 +33,10 @@
 class ImageViewer
 {
     private :
-    SDL_Window * window;
-    SDL_Renderer * renderer;
-    SDL_Surface * m_surface;
-    SDL_Texture * m_texture;
+    SDL_Window * window; ///< Lien vers la fenêtre SDL
+    SDL_Renderer * renderer; ///< Lien vers le renderer
+    SDL_Surface * m_surface; ///< Lien vers la surface
+    SDL_Texture * m_texture; ///< Lien vers la texture
     
 
     public :