Updated README structure

documents/functional/functional-specifications.md

@@ -579,7 +579,7 @@ The following table is showing the duration of each phase in seconds depending o
   | Level 19  | 120                                      | 100%             | 60                                        | 105%             |
   | Level 20+ | 120                                      | 100%             | 60                                        | 105%             |
 
-  - If the player loses a life after being affected by at least one speed increase, Blinky will return back to its default speed until the orange ghost (Clyde) leaves the ghost house. In this case, the applied sppeed to the ghost will be the speed matching the level and remaining pellets in the maze.
+  - If the player loses a life after being affected by at least one speed increase, Blinky will return back to its default speed until the orange ghost (Clyde) leaves the ghost house. In this case, the applied speed to the ghost will be the speed matching the level and remaining pellets in the maze.
 
 - **Pac-Man targetting:**
   - When Blinky is in chase mode, he is targetting the tile where Pac-Man is currently situated, which makes it a danger in the early game.
@@ -598,7 +598,7 @@ The following table is showing the duration of each phase in seconds depending o
 - **Speed variations:**
   - The speed of Pinky is constant and follows the Ghost speed table across the different levels
 - **Pac-Man targetting:**
-  - When Pinky is in chase mode, he looks for Pac-Man position and orientation, and he targets the tile situated four tiles ahead of Pac-Man current position.<br>This behaviour works for the right, left and down position. However, due to an overflow error, when Pac-Man faces up Pinky targets 4 tiles ahead and 4 tiles to the left of him. Even if this behaviour is unintentional, we should reproduce it to have a faithful Pac-Man clone.
+  - When Pinky is in chase mode, it looks for Pac-Man position and orientation, and it targets the tile situated four tiles ahead of Pac-Man current position.<br>This behaviour works for the right, left and down position. However, due to an overflow error, when Pac-Man faces up Pinky targets 4 tiles ahead and 4 tiles to the left of it. Even if this behaviour is unintentional, we should reproduce it to have a faithful Pac-Man clone.
 
 <p align="center"><img src="../pictures/pinky-targeting.png" alt="pac-man gif" width="250"></p>
 

readme.md

@@ -1,17 +1,55 @@
 # <div align="center">2023-2024 Project-2 x86-retrogaming Team-4</div>
 
-## Project team
+# <div align="center">Pac-Man Clone</div>
 
-The team is composed of
+<details>
+<summary>Table of Contents</summary>
+- [2023-2024 Project-2 x86-retrogaming Team-4](#2023-2024-project-2-x86-retrogaming-team-4)
+- [Pac-Man Clone](#pac-man-clone)
+  - [Who are we?](#who-are-we)
+  - [Overview](#overview)
+</details>
 
-- Léo CHARTIER, Project manager
-- Antoine PREVOST, Program manager
-- Malo ARCHIMBAUD, Tech lead
-- Maxime THIZEAU, Software engineer
-- Benoît DE KEYN, Software engineer
-- Maxime CARON, Quality Assurance
-- Thomas PLANCHARD, Quality Assurance
+## Who are we?
+
+| Name         | Role            | Picture                                                                        | 🔗                                                       |
+| ------------ | --------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------- |
+| Léo CHARTIER | Project Manager | ![Léo's profile picture](https://avatars.githubusercontent.com/u/91249751?size=200) | [Léo's Github profile](https://github.com/leo-chartier) |t
+| Antoine PREVOST | Program Manager | ![Antoine's profile picture](https://avatars.githubusercontent.com/u/81081224?size=200) | [Antoine's Github profile](https://github.com/leo-chartier) |
+| Malo ARCHIMBAUD | Tech Lead | ![Malo's profile picture](https://avatars.githubusercontent.com/u/97161471?size=200) | [Malo's Github profile](https://github.com/Malo-Archimbaud) |
+| Maxime THIZEAU | Junior Software Developer | ![Maxime's profile picture](https://avatars.githubusercontent.com/u/145995586?size=200) | [Maxime's Github profile](https://github.com/MaximeTAlgosup) |
+| Benoît DE KEYN | Junior Software Developer | ![Benoît's profile picture](https://avatars.githubusercontent.com/u/146000855?size=200) | [Benoît's Github profile](https://github.com/benoitdekeyn-algosup) |
+| Maxime CARON | Quality Assurance | ![Maxime's profile picture](https://avatars.githubusercontent.com/u/145995231?size=200) | [Maxime's Github profile](https://github.com/MaximeAlgosup) |
+| Thomas PLANCHARD | Quality Assurance | ![Thomas's profile picture](https://avatars.githubusercontent.com/u/91249646?size=200) | [Thomas's Github profile](https://github.com/thomas-planchard) |
 
 ## Overview
 
-This project is about recreating a version of Pac-Man in Assembly.
+This project is about recreating a faithful clone of Pac-Man in Assembly X86 using DOSBox and NASM.
+
+## Requirements
+
+To run this project, you need to meet the following requirements:
+
+- Run one of the following operating systems:
+  - Windows 7/Windows 8/Windows 8.1/Windows 10/Windows 11
+  - Mac OS X
+  - Linux
+  - FreeBSD
+  - Any operating system based on DOS
+- Have an installation of [DOSBox](https://www.dosbox.com/download.php?main=1)
+- Have an installation of [NASM](https://nasm.us/)
+
+## Installation
+
+1. Clone the repository using [Github Desktop](https://desktop.github.com/) or the following command in the command line: `git clone https://github.com/algosup/2023-2024-project-2-x86-retrogaming-team-4.git`
+1. Install [NASM](https://nasm.us/) and [DOSBox](https://www.dosbox.com/download.php?main=1) following the installation process default instructions.
+
+## Configuration
+
+1. Change the configuration of DOSBox using the provided configuration file by replacing the original one.
+1. Run DOSBox with the provided run.bat or run.bash file
+1. Type the following commands:
+    - `c:`
+    - `pacman`
+1. Enjoy playing Pac-Man! 🙌
+