diff --git a/README.md b/README.md index 2b017069a3227ab1c3e291f3bdada332852f1b2c..463f6d3d0bd3b99260983828c9b33b36fd8a777e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Puissance 4 -**Author** +**Author :** Lapaire Sabrina -**Name** +**Name :** TP Puissance 4 of "programmation séquentiel" lesson ## Rules of game @@ -11,24 +11,25 @@ The goal of the game is align a sequence of 4 same pieces on a board. Each round ## Composition The board size is defined by a height (columns) and width (lines). The player one has a piece "O" and the player two or the AI has a piece "X". -## Available mods -**Mod two players** +## Available modes +**Mode two players :** Two players can choose, each his round, the columns for place his pieces. -**Mod Random AI** +**Mode Random AI :** One player play with a random AI. AI places his piece in a random column. -**Mod Smart AI** +**Mode Smart AI :** One player play with a smart AI. AI places his piece in a random column except if it can win on the next round or block the win of the player. ## How to play ? -For play, the user execute the program `./puissance4` with following parameters : -- The game mod (1 for random AI, 2 for smart AI and 3 for two players) -- The height (lines) of the board -- The width (columns) of the board. +**For play**, the user execute the program `./puissance4 <mode> <lines> <columns>`. -When it's launched, the user or users must write the number of the colum who he chose when it's asked, and he presses the enter touch. +- `<mode>` : The game mod (1 for random AI, 2 for smart AI and 3 for two players) +- `<lines>` : The height (lines) of the board +- `<columns>` : The width (columns) of the board. -For launch automatic tests, the user must write `make test` in the terminal (he must to make sure he is in the program folder `tp_puissance4`) and press enter. +When it's launched, the user or users must write the number of the colum who he chose when it's asked, and press enter. -For launch unit tests, the user must write `UnitTests/unit_tests` in the terminal (he must to make sure he is in the program folder `tp_puissance4`) and press enter \ No newline at end of file +**For launch automatic tests**, the user must write `make test` in the terminal (he must to make sure he is in the program folder `tp_puissance4`) and press enter. + +**For launch unit tests**, the user must write `UnitTests/unit_tests` in the terminal (he must to make sure he is in the program folder `tp_puissance4`) and press enter \ No newline at end of file