Skip to content

Commit

Permalink
added git installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Timm Weber committed Mar 20, 2024
1 parent 26b98b9 commit fd8dcd7
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,16 @@
This is a simple TicTacToe game written in Python. IT can be played by two players in a GUI. However, it only works on Windows.

## Installation

- Install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- Clone the repository: `git clone https://github.com/TINF21CS1/TicTacToeKojote.git`
- Alternative to installing Git and cloning the repository: Press the green `Code`-Button on the GitHub Repository in the Browser and click `Download ZIP`. Afterwards, right click the ZIP-file and click unzip.
- Install Python 3.11 or higher from [python.org](https://www.python.org/downloads/)
- Install the required packages by running `pip install -r requirements.txt` from the root directory of the project
- Run the game by executing `python main.py` from the root directory of the project

## Features

- Play TicTacToe with a friend online
- Play TicTacToe with a friend offline
- Play TicTacToe against an AI (weak or strong)
Expand All @@ -16,11 +21,12 @@ This is a simple TicTacToe game written in Python. IT can be played by two playe
- View your game statistics whenever you are connected to a server

## How to play

- **Manage your player profiles:** View Use Case 1: Manage Player Profiles
- **Play against AI:** View the corresponding [sequence diagram](docs/sequence_diagrams/play_vs_ai.png)
- **Play against another player locally:** View the corresponding [sequence diagram](docs/sequence_diagrams/play_locally.png)
- **Host an online game:** View Use Case 3.1: Host Game
- **Join an online game:** View Use Case 3.2: Join Game
- **Leave an online game:** View Use Case 3.3: Leave Game
- **Send Chat messages:** View Use Case 4: Chat
- **Display the statistics:** View Use Case 5: Display Statistics
- **Display the statistics:** View Use Case 5: Display Statistics

0 comments on commit fd8dcd7

Please sign in to comment.