1 files changed, 165 insertions, 125 deletions

diff --git a/report/progression.tex b/report/progression.tex
index 0108d2d..cca0477 100644
--- a/report/progression.tex
+++ b/report/progression.tex
@@ -1,82 +1,72 @@
 \chapter{Work progression}
 
-\section{Zuul bad}
-
-
-
-
-
 \section{Zuul better v1}
 
 \subsection{printLocationInfo}
 
-This code duplication has been previously avoided with the printRoomInfo()
-method.
-It has been renamed to printLocationInfo(), as part of the commit e52a34789, to
-match the exercise.
+e52a34789 - This code duplication has been previously avoided with the
+printRoomInfo() method.
+It has been renamed to printLocationInfo() to match the exercise.
 
 \subsection{getExit}
 
-The exit attributes have been made private and a getter was added in commit
-53c427ff3. A switch statement has been used instead of multiple if statements.
+53c427ff3 - The exit attributes have been made private and a getter has been
+added.
+A switch statement has been used instead of multiple if statements.
 
 \subsection{getExitString}
 
-This method has been added as part of commit ca65af2e2.
+ca65af2e2 - This method, which returns a String containing the informations
+about the Room's exits, has been added.
 
 \subsection{HashMap, setExit}
 
-Room exits are now stored in an HashMap since commit c9d890b9b. The setExits()
-method has been replaced by setExit() which takes advantages of the HashMap.
+c9d890b9b - Room exits are now stored in an HashMap. The setExits() method has
+been replaced by setExit() which takes advantages of the HashMap.
 
 \subsection{Vertical direction}
 
-In commit 4145a5e8c, the getExitString() method has been modified to be able to
+4145a5e8c - The getExitString() method has been modified to be able to
 print the availability of the new exits, used in the stairwell at wing 3. Due
 to the architecture of these rooms, the side exits that were previously settled
 to link them have been kept.
 
 \subsection{keySet ?}
 
-The keySet() method of the class HashMap returns a Set of the keys contained in
-the map.
+The keySet() method of the class HashMap returns a Set of the keys
+associated to values stored in the Map.
 
 \subsection{getExitString ?}
 
-The getExitString() method returns a String listing the room's exits.
-To achieve that, it iterates through the exits Map's keys, that is a Set of
-Strings, appending each one to the String that it returns.
+The getExitString() method returns a String listing the Room's exits.
+To achieve that, it iterates through the exits Map's keys, which is a Set of
+String-s, appending each one to the String that it returns.
 
 \subsection{getLongDescription}
 
-The Room class now uses the previously explained getExitString() method and
-includes the getLongDescription() method that returns the full description of
-the room since commit e510b08d0.
-
-\subsection{Object diagram}
-
-%TODO
-
-\subsubsection{Changes on execution}
+e510b08d0 - The Room class now uses the previously explained getExitString()
+method and includes the getLongDescription() method that returns the full description of
+the room.
 
-%TODO
 
 \section{Zuul with features}
 
 \subsection{look}
 
-The look command has been added with the commit 698e3cd25.
+698e3cd25 - The look command, which prints informations about the current Room,
+has been added.
 
 \subsection{eat}
 
-The eat command has been added with the commit 40b9b4816.
-
+40b9b4816 - The eat command, that just prints a special message, has been added.
+This command has then been deleted later in the development since it was
+useless in the scenario.
 
 \section{Zuul better v2}
 
 \subsection{showAll, showCommands}
 
-This modifications are part of the commit 79d33230b.
+79d33230b - Theses methods have been implemented.
 
 \subsection{Adding commands}
 
@@ -86,50 +76,49 @@ the Game class and its processCommand() method.
 
 \subsection{getCommandList}
 
-The command list is not printed in the CommandWords class anymore. Instead, this
-class returns a String, forwarded by the Parser class, that is then printed in
-the Game class, thanks to commit 5f1d0ada2.
+5f1d0ada2 - The command list is not printed in the CommandWords class anymore.
+Instead, this class returns a String, forwarded by the Parser class, that is
+then printed in the Game class.
 
 \subsection{Comparison with reference}
 
-The printLocationInfo() method, used only twice, has been trimmed by the commit
-590a932e5 and has been replaced by a call to the getLongDescription() method of
-the Room class.
+590a932e5 - The printLocationInfo() method, used only twice, has been trimmed
+and has been replaced by a call to the getLongDescription() method of the Room
+class.
 
-A missing getter for the Room description has been added as part of the commit
-f84606424.
+f84606424 - A missing getter for the Room description has been added.
 
-The loop building the command list String has been modified to use an Iterator
-with the commit 0c5793abf.
+0c5793abf - The loop building the command list String has been modified to use
+an Iterator.
 
 \subsection{StringBuilder}
 
-The command list and the exit list are now created using a StringBuilder since
-commit ee5ec33aa. This avoids the creation of a new String object at each
+ee5ec33aa - The command list and the exit list are now created using a
+StringBuilder. This avoids the creation of a new String object at each
 concatenation, and thus allows better performances.
 
 \subsection{Room objects}
 
-Rooms are now stored in an HashMap since commit f64f1ffb0, so they can be
-passed to any method in any class.
+f64f1ffb0 - Rooms are now stored in an HashMap, so they can be passed to any
+method in any class.
 
 \section{Zuul with images}
 
 \subsection{Game, GameEngine, UserInterface}
 
-The following methods was implemented as part of commit 54e102463.
+54e102463 - The methods have been implemented.
 
 \subsubsection{Game}
 
 The constructor of this class instantiates the GameEngine and the UserInterface,
-and set the output of the first to the second.
+and sets the output of the first to the second.
 
 \subsubsection{GameEngine}
 
 This class contains the attributes and methods previously contained in the Game
 class.
 
-Instead of printing to the standard console output, it prints to the GUI.
+Instead of printing to the standard console output, it prints to the Swing GUI.
 
 \subsubsection{UserInterface}
 
@@ -140,7 +129,9 @@ interact with them.
 \subsection{Parser/Scanner}
 
 Since commands are entered through a text field instead of the console, the
-use of Scanner that read from the standard system input is not required anymore.
+use of Scanner that read from the standard system input is not required for the
+Swing GUI.
+
 
 \subsection{addActionListener() and actionPerformed()}
 
@@ -153,10 +144,10 @@ event that happened.
 
 \subsection{Add a button}
 
-A help button was added with commit 7f153a4c1. The processCommand() method was
-modified to take the command String as parameter instead of reading it only from
-the text field, and the actionPerformed() method was modified accordingly to
-forward the command.
+7f153a4c1 - A help button has been added. The processCommand() method has been
+modified to take the command String as a parameter instead of reading it only
+from the text field, and the actionPerformed() method has been modified
+accordingly to forward the command.
 
 
 \section{Zuul MVC}
@@ -178,15 +169,21 @@ program, which are the GameEngine, the Interpret, the Parser and the Performer.
 They handle the events created by the user's actions and modify the Game model
 accordingly, refreshing the view to display the new game state.
 
-Several internal modifications in the existing classes were made in order to
-separate the logic from the data storage as part of commit bd639caa0.
+bd639caa0 - Several internal modifications in the existing classes were made in
+order to separate the logic from the data storage.