added releases info

Author: vmsaif

README.md

@@ -6,35 +6,156 @@
 
 The program uses the A* algorithm to find the shortest path from the ant to the food. The ant is the start and the food is the goal. The ant can move in 8 directions. 
 
-When the game starts, the user is asked to select 
-
--the start and the goal cells
--the obstacle cells
--the nature of the terrain for each cell between
+When the game starts, the user is asked to select:
+- The start and the goal cells.
+- The obstacle cells.
+- The nature of the terrain for each cell between:
     - Open Terrain	
     - Grassland
     - Swampland
     - Obstacles
 
 After the user has selected the cells, the program calculates the shortest path from the ant to the food. The program uses the A* algorithm to find the shortest path. The A* algorithm uses a heuristic function to find the shortest path. The heuristic function used in this program is the Manhattan distance. The program shows the search evaluation of the A* algorithm. When the path is found, the ant starts moving from the start cell to the goal cell.
 
-## Compiling and Running
+## About This Repository
+
+This repository uses CI/CD to automatically build and release the program for Windows, macOS, and Linux. The program is packaged as a JAR file. The JAR file is then packaged into an MSI file for Windows, a DMG file for macOS, and a DEB file for Linux. The program is built using GitHub Actions and is released using GitHub Releases. The program is built for the following platforms:
+
+- Windows (64-bit)
+- macOS (64-bit)
+- Linux (64-bit)
+- JAR File
+
+You can find them here in the [Releases](https://github.com/vmsaif/ant-path-finding-using-A-Star-algorithm/releases) section.
+
+## Running the Program
+
+- Make sure you have JRE installed on your computer. You can download JRE [here](https://adoptium.net/) or [here](https://www.oracle.com/java/technologies/javase-jre8-downloads.html).
+
+Downloading the jar file is preferred. You can download the release version of the Game from the latest release [here](https://github.com/vmsaif/ant-path-finding-using-A-Star-algorithm/releases). The program is packaged as a JAR file. You can run the program by double-clicking on the JAR file.
+
+## **Ubuntu**
+
+### Option 1: Downloading the DEB File (simpler)
+
+1. Open the terminal and navigate to the directory where you downloaded the .deb file.
+
+```bash
+cd ~/Downloads
+```
+
+2. Run the following command to install the package:
+
+```bash
+sudo dpkg -i ./ant-path-finding-v1.0.0-linux_amd64.deb # Replace the filename/version with the name of the DEB file you downloaded
+```
+3. If you get an error, run the following command to install the dependencies:
+
+```bash
+sudo apt-get install -f
+```
+
+4. Run the following command to start the game:
+
+You can start the game by searching for it in the applications menu named `ant-path-finding` or by running the following command in the terminal:
+```bash
+/opt/ant-path-finding/bin/ant-path-finding
+```
+
+### Option 2: Downloading the JAR File
+
+1. **Installing Java** (if it's not already installed):
+   ```bash
+   sudo apt update
+   sudo apt install default-jre
+   ```
+
+2. **Navigate to the Download Location**:
+   ```bash
+   cd ~/Downloads
+   ```
+
+3. **Provide Execute Permissions** (Optional, but useful if you want to execute it directly):
+   ```bash
+   chmod +x ant-path-finding-v1.0.0.jar # Replace the filename with the name of the JAR file you downloaded
+   ```
+
+4. **Run the JAR File**:
+   ```bash
+   java -jar ant-path-finding-v1.0.0.jar # Replace the filename with the name of the JAR file you downloaded
+   ```
+
+## **macOS**
+There are 2 methods. Downloading the dmg file or downloading the jar file. 
+### Option 1: Downloading the DMG File (simpler)
+I am not a registered Apple developer, That is why you will get a warning when you try to open the app. Thus, you will have to bypass the security settings to run the app.
+Here are the steps:
+
+1. Click on the .dmg file you have downloaded. 
+
+2. Drag the app to the Applications folder.
+
+3. In the Finder, locate the Ant Path Finding app.
+
+   (Don’t use Launchpad to do this. Launchpad doesn’t allow you to access the shortcut menu.)
+
+4. Press and hold Control then click the app icon.
+
+5. Click Open.
+
+   The app is saved as an exception to your security settings, and you can open it in the future by double-clicking it just as you can any registered app.
+
+### Option 2: Downloading the JAR File
+Make sure you have JRE installed on your computer. You can download JRE [here](https://adoptium.net/) or [here](https://www.oracle.com/java/technologies/javase-jre8-downloads.html).
+
+1. **Navigate to the Download Location** (using Terminal):
+   ```bash
+   cd ~/Downloads
+   ```
+
+3. **Provide Execute Permissions** (Optional):
+   ```bash
+   chmod +x ant-path-finding-v1.0.0.jar # Replace the filename with the name of the JAR file you downloaded
+   ```
+
+4. **Run the JAR File**:
+   ```bash
+   java -jar ant-path-finding-v1.0.0.jar # Replace the filename with the name of the JAR file you downloaded
+   ```
+
+## **Windows**
+
+### Option 1: Downloading the MSI File (simpler)
+
+1. Open the folder where you downloaded the MSI file.
+2. Double-click on the MSI file to run it.
+
+At this point, windows smart screen will block the app from running. As I am not a signed developer by Microsoft, this warning will appear. 
 
-### Compiling
-The game uses a simple state machine to manage the different states of the game. 
+3. If you get the warning, click on "More Info" and then click on "Run Anyway".
+4. Wait for the installation to complete.
+5. Run the game from the Desktop shortcut.
 
-- Run the command `javac -d bin src/*.java` to compile the Java files in the `src` directory to `bin/` directory.
-- Run the command `java -cp bin/ App` to run the main game.
+### Option 2: Downloading the JAR File
 
-## Resources
+1. **Confirming Java**:
 
-### Images
-- [App Icon](https://www.flaticon.com/free-icon/ant_1779584)
-- [Ant Image](https://www.pngegg.com/en/png-zblks)
-- [Food Image](https://www.pngegg.com/en/png-medpx)
+   Make sure you have JRE installed on your computer. You can download JRE [here](https://adoptium.net/) or [here](https://www.oracle.com/java/technologies/javase-jre8-downloads.html).
 
-### Bugs:
-I have not found any bugs in the program yet. If you find any, please let me know.
+   Ensure that Java is added to your `PATH` so that it can be accessed from the command prompt. During the jre installation, You will have option to add to your path. Is is unchecked by default. Make sure to enable it.  To check if Java is installed, run the following command in Command Prompt or PowerShell:
+   ```bash
+   java -version
+   ```
+   If Java is installed, you should see the version number. If you see an error, you need to install Java. See above for instructions on installing Java.
 
+2. **Navigate to the Download Location** (using Command Prompt or PowerShell):
+   ```bash
+   cd c:\Users\username\Downloads # Replace username with your username
+   ```
 
+3. **Run the JAR File**:
+   ```bash
+   java -jar ant-path-finding-v1.0.0.jar
+   ```
 
+In all cases, once the commands are followed, the Java application packaged inside the JAR file should start running.