From 286fe32084df61f1213c4f21668ab53bd0929253 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Th=C3=A9o=20LUDWIG?= <contact@theoludwig.fr>
Date: Mon, 2 Dec 2024 10:24:34 +0100
Subject: [PATCH] refactor: move Documentation and UML folders (#11)

---
 .../Sujet-Projet-Geometry-Dash.pdf             | Bin
 {uml => Documentation/UML}/README.md           |   2 +-
 .../activity-diagram-complete.puml             |   4 +++-
 .../activity-diagram}/activity-diagram.puml    |   6 +++---
 .../activity-diagram/sub-activation-bonus.puml |  15 +++++++++++++++
 .../UML/activity-diagram/sub-bonus.puml        |   6 ++++--
 .../UML/activity-diagram/sub-bumper.puml       |   6 ++++--
 .../UML/activity-diagram/sub-forme.puml        |  17 +++++++++++++++++
 .../UML/activity-diagram/sub-pieces.puml       |   6 ++++--
 {uml => Documentation/UML}/class-diagram.puml  |   0
 Documentation/UML/state-diagram.puml           |   3 +++
 .../UML}/use-case-diagram.puml                 |   0
 {docs => Documentation}/conventions.md         |   0
 README.md                                      |   6 +++---
 uml/sub_activation_bonus.puml                  |  13 -------------
 uml/sub_forme.puml                             |  15 ---------------
 16 files changed, 57 insertions(+), 42 deletions(-)
 rename {docs => Documentation}/Sujet-Projet-Geometry-Dash.pdf (100%)
 rename {uml => Documentation/UML}/README.md (90%)
 rename {uml => Documentation/UML/activity-diagram}/activity-diagram-complete.puml (98%)
 rename {uml => Documentation/UML/activity-diagram}/activity-diagram.puml (96%)
 create mode 100644 Documentation/UML/activity-diagram/sub-activation-bonus.puml
 rename uml/sub_bonus.puml => Documentation/UML/activity-diagram/sub-bonus.puml (57%)
 rename uml/sub_bumper.puml => Documentation/UML/activity-diagram/sub-bumper.puml (61%)
 create mode 100644 Documentation/UML/activity-diagram/sub-forme.puml
 rename uml/sub_pieces.puml => Documentation/UML/activity-diagram/sub-pieces.puml (59%)
 rename {uml => Documentation/UML}/class-diagram.puml (100%)
 create mode 100644 Documentation/UML/state-diagram.puml
 rename {uml => Documentation/UML}/use-case-diagram.puml (100%)
 rename {docs => Documentation}/conventions.md (100%)
 delete mode 100644 uml/sub_activation_bonus.puml
 delete mode 100644 uml/sub_forme.puml

diff --git a/docs/Sujet-Projet-Geometry-Dash.pdf b/Documentation/Sujet-Projet-Geometry-Dash.pdf
similarity index 100%
rename from docs/Sujet-Projet-Geometry-Dash.pdf
rename to Documentation/Sujet-Projet-Geometry-Dash.pdf
diff --git a/uml/README.md b/Documentation/UML/README.md
similarity index 90%
rename from uml/README.md
rename to Documentation/UML/README.md
index eefbb23..0b2c5dc 100644
--- a/uml/README.md
+++ b/Documentation/UML/README.md
@@ -7,4 +7,4 @@ Les modélisation UML du projet sont disponibles sous forme de [PlantUML](https:
 - [Diagramme de classes](./class-diagram.puml)
 - [Diagramme d'activités](./activity-diagram.puml)
 - [Diagramme de cas d'utilisation](./use-case-diagram.puml)
-- [Diagramme d'états du joueur](./player-state-diagram.puml)
+- [Diagramme d'états](./state-diagram.puml)
diff --git a/uml/activity-diagram-complete.puml b/Documentation/UML/activity-diagram/activity-diagram-complete.puml
similarity index 98%
rename from uml/activity-diagram-complete.puml
rename to Documentation/UML/activity-diagram/activity-diagram-complete.puml
index 5ca2a8d..dec7ce3 100644
--- a/uml/activity-diagram-complete.puml
+++ b/Documentation/UML/activity-diagram/activity-diagram-complete.puml
@@ -1,4 +1,5 @@
-@startuml activity-diagram
+@startuml Geometry Dash - Diagramme d'activités
+
 start
 
 :Lancer la partie;
@@ -93,4 +94,5 @@ repeat
 repeat while (Le joueur n'a pas fini le niveau)
 
 stop
+
 @enduml
diff --git a/uml/activity-diagram.puml b/Documentation/UML/activity-diagram/activity-diagram.puml
similarity index 96%
rename from uml/activity-diagram.puml
rename to Documentation/UML/activity-diagram/activity-diagram.puml
index 6870869..a2f4bcd 100644
--- a/uml/activity-diagram.puml
+++ b/Documentation/UML/activity-diagram/activity-diagram.puml
@@ -1,4 +1,5 @@
-@startuml activity-diagram
+@startuml Geometry Dash - Diagramme d'activités
+
 start
 
 :Lancer la partie;
@@ -10,7 +11,6 @@ repeat
         :Augmenter le nombre d'essais de 1;
         :Perdre toutes les pièces et bonus;
     else (Non)
-        ' --- Première Ligne ---
         partition "Saut" {
             if (L'utilisateur clique sur l'écran ?) then (Oui)
                 :Le joueur effectue un saut;
@@ -76,7 +76,6 @@ repeat
         }
     endif
 
-    ' --- Fin du Niveau ---
     partition "Fin du Niveau" {
         if (Le joueur touche la zone de fin ?) then (Oui)
             :Terminer le niveau;
@@ -94,4 +93,5 @@ repeat
 repeat while (Le joueur n'a pas fini le niveau)
 
 stop
+
 @enduml
diff --git a/Documentation/UML/activity-diagram/sub-activation-bonus.puml b/Documentation/UML/activity-diagram/sub-activation-bonus.puml
new file mode 100644
index 0000000..6a1b106
--- /dev/null
+++ b/Documentation/UML/activity-diagram/sub-activation-bonus.puml
@@ -0,0 +1,15 @@
+@startuml sub-activation-bonus
+
+start
+:Le joueur clique sur un bonus dans l'inventaire;
+switch (Type de bonus)
+  case (Temps ralenti)
+    :Activer ralentissement du temps;
+    :Temps ralenti : 3 secondes;
+  case (Annulation d'obstacle)
+    :Supprimer tous les obstacles;
+    :Durée : 3 secondes;
+endswitch
+stop
+
+@enduml
diff --git a/uml/sub_bonus.puml b/Documentation/UML/activity-diagram/sub-bonus.puml
similarity index 57%
rename from uml/sub_bonus.puml
rename to Documentation/UML/activity-diagram/sub-bonus.puml
index a552d3a..7452333 100644
--- a/uml/sub_bonus.puml
+++ b/Documentation/UML/activity-diagram/sub-bonus.puml
@@ -1,8 +1,10 @@
-@startuml
+@startuml sub-bonus
+
 start
 if (Le joueur touche un bonus ?) then (Oui)
-    :Ajouter le bonus à l'inventaire;
+  :Ajouter le bonus à l'inventaire;
 else (Non)
 endif
 stop
+
 @enduml
diff --git a/uml/sub_bumper.puml b/Documentation/UML/activity-diagram/sub-bumper.puml
similarity index 61%
rename from uml/sub_bumper.puml
rename to Documentation/UML/activity-diagram/sub-bumper.puml
index b5ffde7..350314a 100644
--- a/uml/sub_bumper.puml
+++ b/Documentation/UML/activity-diagram/sub-bumper.puml
@@ -1,8 +1,10 @@
-@startuml
+@startuml sub-bumper
+
 start
 if (Le joueur touche un bumper ?) then (Oui)
-    :Effectuer un grand saut;
+  :Effectuer un grand saut;
 else (Non)
 endif
 stop
+
 @enduml
diff --git a/Documentation/UML/activity-diagram/sub-forme.puml b/Documentation/UML/activity-diagram/sub-forme.puml
new file mode 100644
index 0000000..efc1035
--- /dev/null
+++ b/Documentation/UML/activity-diagram/sub-forme.puml
@@ -0,0 +1,17 @@
+@startuml sub-forme
+
+start
+:Changement de forme via portail;
+switch (Forme)
+  case (Forme fusée)
+    :Mode fusée;
+  case (Forme roue)
+    :Mode roue;
+  case (Forme sens inversé)
+    :Mode sens inversé;
+  case (Forme gravité inversée)
+    :Mode gravité inversée;
+endswitch
+stop
+
+@enduml
diff --git a/uml/sub_pieces.puml b/Documentation/UML/activity-diagram/sub-pieces.puml
similarity index 59%
rename from uml/sub_pieces.puml
rename to Documentation/UML/activity-diagram/sub-pieces.puml
index fa70269..7b75761 100644
--- a/uml/sub_pieces.puml
+++ b/Documentation/UML/activity-diagram/sub-pieces.puml
@@ -1,8 +1,10 @@
-@startuml
+@startuml sub-pieces
+
 start
 if (Le joueur touche une pièce ?) then (Oui)
-    :Ajouter la pièce au niveau;
+  :Ajouter la pièce au niveau;
 else (Non)
 endif
 stop
+
 @enduml
diff --git a/uml/class-diagram.puml b/Documentation/UML/class-diagram.puml
similarity index 100%
rename from uml/class-diagram.puml
rename to Documentation/UML/class-diagram.puml
diff --git a/Documentation/UML/state-diagram.puml b/Documentation/UML/state-diagram.puml
new file mode 100644
index 0000000..879204f
--- /dev/null
+++ b/Documentation/UML/state-diagram.puml
@@ -0,0 +1,3 @@
+@startuml Geometry Dash - Diagramme d'états
+
+@enduml
diff --git a/uml/use-case-diagram.puml b/Documentation/UML/use-case-diagram.puml
similarity index 100%
rename from uml/use-case-diagram.puml
rename to Documentation/UML/use-case-diagram.puml
diff --git a/docs/conventions.md b/Documentation/conventions.md
similarity index 100%
rename from docs/conventions.md
rename to Documentation/conventions.md
diff --git a/README.md b/README.md
index 1f0f8a2..5afd1c2 100644
--- a/README.md
+++ b/README.md
@@ -12,10 +12,10 @@ Développement d'une reproduction du jeu [Geometry Dash](https://fr.wikipedia.or
 
 ### Documentation et Liens
 
-- [Sujet](./docs/Sujet-Projet-Geometry-Dash.pdf)
-- [Conventions développement informatique](./docs/conventions.md)
+- [Sujet](./Documentation/Sujet-Projet-Geometry-Dash.pdf)
 - [Kanban Board (Trello)](https://trello.com/b/ugG5Siaw/cnam-geometry-dash)
-- [Diagrammes UML](./uml/README.md)
+- [Diagrammes UML](./UML)
+- [Conventions développement informatique](./Documentation/conventions.md)
 
 ## Prérequis
 
diff --git a/uml/sub_activation_bonus.puml b/uml/sub_activation_bonus.puml
deleted file mode 100644
index f5aea51..0000000
--- a/uml/sub_activation_bonus.puml
+++ /dev/null
@@ -1,13 +0,0 @@
-@startuml
-start
-:Le joueur clique sur un bonus dans l'inventaire;
-switch (Type de bonus)
-    case (Temps ralenti)
-        :Activer ralentissement du temps;
-        :Temps ralenti : 3 secondes;
-    case (Annulation d'obstacle)
-        :Supprimer tous les obstacles;
-        :Durée : 3 secondes;
-endswitch
-stop
-@enduml
diff --git a/uml/sub_forme.puml b/uml/sub_forme.puml
deleted file mode 100644
index c5d58e9..0000000
--- a/uml/sub_forme.puml
+++ /dev/null
@@ -1,15 +0,0 @@
-@startuml
-start
-:Changement de forme via portail;
-switch (Forme)
-    case (Forme fusée)
-        :Mode fusée;
-    case (Forme roue)
-        :Mode roue;
-    case (Forme sens inversé)
-        :Mode sens inversé;
-    case (Forme gravité inversée)
-        :Mode gravité inversée;
-endswitch
-stop
-@enduml