diff --git a/README.md b/README.md
index 0d74a457..d829b825 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,16 @@
# Group Project in TDT4240 - Software Architecture
+



-[](https://img.shields.io/badge/version-0.0.1-blue)
+[](https://img.shields.io/badge/version-1.0.0-blue)
+
+
+
@@ -25,18 +29,17 @@
## Introduction
-
## Installation and Setup
-
### Prerequisites
+
Git
Git is a distributed version control system that is used to manage the source code of this project. It is essential for cloning the project from GitHub and collaborating with other developers.
- * Git - Version Control System
- * Download and install Git from the official [Git website](https://git-scm.com/downloads).
- * After installation, verify the installation by running ```git --version``` in your command line or terminal.
+- Git - Version Control System
+_ Download and install Git from the official [Git website](https://git-scm.com/downloads).
+_ After installation, verify the installation by running `git --version` in your command line or terminal.
@@ -44,9 +47,9 @@
Java JDK 17 (Download from Oracle's website)
This project requires Java JDK to be installed. The project is tested with JDK 17.
- * Java JDK 17 - Java Development Kit is essential for compiling and running Java applications.
- * Download and install it from [Oracle's Java JDK Download Page](https://www.oracle.com/java/technologies/downloads/#java17) or adopt an open-source JDK like AdoptOpenJDK.
- * After installation, verify the installation by running ```java -version``` and ```javac -version``` in your command line or terminal.
+- Java JDK 17 - Java Development Kit is essential for compiling and running Java applications.
+_ Download and install it from [Oracle's Java JDK Download Page](https://www.oracle.com/java/technologies/downloads/#java17) or adopt an open-source JDK like AdoptOpenJDK.
+_ After installation, verify the installation by running `java -version` and `javac -version` in your command line or terminal.
@@ -54,10 +57,9 @@
Gradle 6.7
Gradle is used as the build tool for this project. It automates the process of building, testing, and deploying the application.
- * Gradle 6.7 - Gradle brings advanced build toolkit to manage dependencies and other aspects of the build process.
- * You can download Gradle from the [Gradle Download Page](https://gradle.org/install/).
- * Alternatively, if you are using a Gradle Wrapper script (gradlew or gradlew.bat), you do not need to manually install Gradle, as the wrapper script will handle the installation for you.
- * To confirm that Gradle is properly installed, run ```gradlew -v``` in your command line or terminal which will display the installed Gradle version.
+- Gradle 6.7 - Gradle brings advanced build toolkit to manage dependencies and other aspects of the build process.
+_ You can download Gradle from the [Gradle Download Page](https://gradle.org/install/).
+_ Alternatively, if you are using a Gradle Wrapper script (gradlew or gradlew.bat), you do not need to manually install Gradle, as the wrapper script will handle the installation for you. \* To confirm that Gradle is properly installed, run `gradlew -v` in your command line or terminal which will display the installed Gradle version.
@@ -87,35 +89,42 @@
-Ensure that both Java and Gradle are properly installed and configured in your system's PATH environment variable to be able to run the game.
+Ensure that both Java and Gradle are properly installed and configured in your system's PATH environment variable to be able to run the game.
### Installing
+
To install the project, you can use the following commands:
+
```cmd
git clone https://github.com/SverreNystad/besieged.git
```
-
## How to Play
+
The game can be played on both desktop and Android.
To start the game, you can start it on desktop using the following command:
+
```cmd
gradlew desktop:run
```
To start the game on Android, you can use the following command:
+
```cmd
gradlew android:run
```
## Running the tests
+
To run the tests, you can use the following command:
+
```cmd
./gradlew test
```
## Contributors
+
diff --git a/docs/images/besieged.png b/docs/images/besieged.png
new file mode 100644
index 00000000..915bca82
Binary files /dev/null and b/docs/images/besieged.png differ
|