Merge branch 'main' of https://github.com/Adibov/Werewolf

README.md

@@ -1,2 +1,12 @@
-# Werewolf
-Werewolf(Mafia) party game, written in Java for Advanced Programming midterm project.
+# Mafia Party Game
+![mafia-game](https://cdn-apabk.nitrocdn.com/QQUvjmPGpOGmpUxCkqAsSnVUjfEULAuk/assets/static/optimized/rev-9b34b5b/wp-content/uploads/2019/04/Mafia-Game-e1610793771411.jpg)
+[Image Source](https://icebreakerideas.com/mafia-game/)
+
+## Introduction
+Mafia is a party game that can be played by 6 or more players. All players are distributed into two teams named **Mafias** and **Citizens**. The goal for each team is to defeat other team by killing them. Each turn consist of two phases called **Day** and **Night** in which players have to act their role to become victorios.
+For more information and get to know more about the game, checkout [this link](https://icebreakerideas.com/mafia-game/).
+
+## How to Use
+- Make sure [Oracle OpenJDK 16.0.1](https://www.oracle.com/java/technologies/javase-jdk16-downloads.html) is installed on your device
+- Start server by running `RunGod.sh` which is placed in `God` folder (if you are running on windows, simplify double-click on `RunGod.bat`)
+- After that, each player can connect to the server by running `RunPlayer.sh` which is placed in `Player` folder (again, if you are on windows, just double-click on `RunPlayer.bat`)