Merge pull request #95 from algosup/documents

Edited README launching commands

documents/functional/functional-specifications.md

@@ -651,11 +651,11 @@ Pinky's targetting in when Pac-Man faces up.
 ##### Inky (Blue ghost)
 
 - **Spawn:**
-  - Inky also spawns in the ghost house and is the 2nd ghost to come out of it. It spawns on the left part of the house, allowing Pinky which is situated in the center to exit it before itself. However, it cannot come out of it while Pac-Man has not eaten 30 pellets yet.
+  - Inky also spawns in the ghost house and is the 2nd ghost to come out of it. It spawns on the left part of the house, allowing Inky which is situated in the center to exit it before itself. However, it cannot come out of it while Pac-Man has not eaten 30 pellets yet.
 - **Speed variations:**
-  - The speed of Pinky is constant and follows the Ghost speed table across the different levels
+  - The speed of Inky is constant and follows the Ghost speed table across the different levels
 - **Pac-Man targetting:**
-  - In chase mode, Inky uses the most diffuclt targetting scheme. He needs Pac-Man's current tile and orientation and Bliky's current tile.<br>First, you have to take the tile situated two tiles ahead of Pac-Man, considering his current direction. You then imagine a vector from Blinky's current tile to the tile situated 2 tiles ahead of Pac-Man. Finally, you multiply by 2 the length of this vector, and the end of it will show the targetted tile by Inky.
+  - In chase mode, Inky uses the most diffuclt targetting scheme. He needs Pac-Man's current tile and orientation and Inky's current tile.<br>First, you have to take the tile situated two tiles ahead of Pac-Man, considering his current direction. You then imagine a vector from Inky's current tile to the tile situated 2 tiles ahead of Pac-Man. Finally, you multiply by 2 the length of this vector, and the end of it will show the targetted tile by Inky.
 
 <p align="center"><img src="../pictures/inky-targeting.png" alt="pac-man gif" width="250"></p>
 

readme.md

@@ -47,14 +47,16 @@ To run this project, you need to meet the following requirements:
 ## 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.
+1. Install [NASM](https://www.nasm.us/pub/nasm/releasebuilds/2.16.01/dos/nasm-2.16.01-dos-upx.zip) by unziping it and place this last in a folder named `nasm` in the clone folder.
+1. Install [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:
+1. Open your command line and go to your clone folder root: `cd %absolute_path_to_clone_folder%`
+2. Run the following command: `nasm/nasm src/main.asm -f bin -o pacman.com`
+3. Run DOSBox
+4. Type the following commands in the command line interface of DOSBox:
+    - `MOUNT c %absolute_path_to_clone_folder%`
     - `c:`
     - `pacman`
-1. Enjoy playing Pac-Man! 🙌
-
+5. Enjoy playing Pac-Man! 🙌