Description du diagramme de classe + saut de ligne pour + de lisibilité

README.md

@@ -7,15 +7,15 @@ classDiagram
         + PremierEp : int
         + Description : string
         + Caracteristique : string
-        + Bateau(nom : string, nomRomanise :  string, premierChap : int, premierEp : int, description : string,  caracteristique : string, image : string)
-        + Bateau(nom : string, nomRomanise :  string, affiliation :  Equipage , premierChap : int, premierEp : int, description : string, caracteristique : string, image : string)
+        + Bateau(nom : string, nomRomanise :  string, premierChap : int, premierEp : int,\n description : string,  caracteristique : string, image : string)
+        + Bateau(nom : string, nomRomanise :  string, affiliation :  Equipage , premierChap : int,\n premierEp : int, description : string, caracteristique : string, image : string)
     }
 
     class Bestiaire {
         + Origine : string
         + Description : string
         + Caracteristique : string
-        + Bestiaire(nom : string, origine : string, description :  string, caracteristique : string, image : string)
+        + Bestiaire(nom : string, origine : string,\n description :  string, caracteristique : string, image : string)
     }
 
     class Equipage {
@@ -25,7 +25,7 @@ classDiagram
         + PremierEp : int
         + Statut : bool
         + Description : string
-        + Equipage(nom : string, nomRomanise :  string, region : string, premierChap : int, premierEp : int, statut : bool, description : string , image : string)
+        + Equipage(nom : string, nomRomanise :  string, region : string, premierChap : int,\n premierEp : int, statut : bool, description : string , image : string)
     }
 
     class FruitDuDemon {
@@ -36,8 +36,8 @@ classDiagram
         + Description : string
         + Forces : string
         + Faiblesses : string
-        + FruitDuDemon(nom : string, nomRomanise :  string, type : string, premierChap : int, premierEp : int, description : string, forces : string, faiblesses : string, image : string)
-        + FruitDuDemon(nom : string, nomRomanise :  string, type : string, premierChap : int, premierEp : int, description : string, forces : string, faiblesses : string, image : string, utilisateur : List~Personnage~)
+        + FruitDuDemon(nom : string, nomRomanise :  string, type : string,\n premierChap : int, premierEp : int, description : string,\n forces : string, faiblesses : string, image : string)
+        + FruitDuDemon(nom : string, nomRomanise :  string, type : string,\n premierChap : int, premierEp : int, description : string, forces : string,\n faiblesses : string, image : string, utilisateur : List~Personnage~)
     }
 
     class Ile {
@@ -47,7 +47,7 @@ classDiagram
         + PremierEp : int
         + Description : string
         + Geographie : string
-        + Ile(nom : string, nomRomanise :  string, region : string, premierChap : int, premierEp : int, description : string, geographie : string, image : string)
+        + Ile(nom : string, nomRomanise :  string, region : string, premierChap : int, \n premierEp : int, description : string, geographie : string, image : string)
     }
 
     class Personnage {
@@ -58,7 +58,7 @@ classDiagram
         + Origine : string
         + Biographie : string
         + Citation : string
-        + Personnage(nom : string, prime : double, epithete : string, int age, taill: double, origine : string, biographie : string, citation : string, image : string)
+        + Personnage(nom : string, prime : double, epithete : string, int age, taille : double,\n origine : string, biographie : string, citation : string, image : string)
     }
 
     class ObjetOhara {
@@ -82,8 +82,25 @@ classDiagram
     Equipage --|> ObjetOhara
     Bateau --|> ObjetOhara
     Bestiaire --|> ObjetOhara
+```
 
+# Description
+
+Ceci est le diagramme de classe de notre application Ohara.
+
+Il possède 7 classes : 
+    
+    -Bateau
+    -Bestiaire (qui représente toutes les différentes races dans l'univers de One Piece)
+    -Equipage
+    -Fruit du démon
+    -Ile 
+    -Personnage
+    -Objet Ohara (Regroupe le nom et l'image qui reviennent à chaque fois dans toutes les classes)
+
+Nous avons regroupé le nom et l'image dans une classe "Objet Ohara" dont toutes les autres classes hérite pour éviter la redondance.
+
+Ce diagramme de classe représente la structure de notre application.
 
 
-```