From 1d94ded1a4f1725f33180213fb0ee76619773808 Mon Sep 17 00:00:00 2001
From: Lucy Ciara Herud-Thomassen <86323303+LucyCiara@users.noreply.github.com>
Date: Thu, 23 Apr 2026 12:35:22 +0200
Subject: [PATCH] chore&update[README]: update installation guide and remove
 TODOs

---
 README.md | 54 +++++++++++++++++++++++++++---------------------------
 1 file changed, 27 insertions(+), 27 deletions(-)

diff --git a/README.md b/README.md
index 7d77679..a15b28c 100644
--- a/README.md
+++ b/README.md
@@ -108,7 +108,6 @@ src/main/resources/                               (Static assets - CSS, images,
     └── donationpage.css                          (Donation flow styling)
 </pre>
 
-[//]: # (TODO: Describe the structure of your project here. How have you used packages in your structure. Where are all sourcefiles stored. Where are all JUnit-test classes stored. etc.)
 
 ### 📦 Package Responsibilities
 
@@ -177,47 +176,49 @@ The project uses the standard Maven directory structure, which ensures:
 - compatibility with IDEs such as IntelliJ, VS Code, and Eclipse
 - maintainability and easy future extensions (e.g., persistence or additional views)
 
----
-
 ## Link to repository📚
 
-[//]: # (TODO: Include a link to your GitHub repository here.)
-[GitHub Repository - IDATT1005 Project Spring 2026](https://git.ntnu.no/Group-5/Help-Me-Help)
-
----
+https://git.ntnu.no/Group-5/Help-Me-Help
 
 ## How to run the project📝
 
-[//]: # (TODO: Describe how to run your project here. What is the main class? What is the main method?
-What is the input and output of the program? What is the expected behaviour of the program?)
-
 **Requirements:**  
 
 - Java JDK 25  
 - Maven  
-- IDE (Ideally IntelliJ or VSCode with Java Extension Pack)
+- JavaFX SDK 25.0.1--
 
-**Steps:**
+**Run With Maven:**      (Windows + Mac + Linux)
 
-1. **Clone repository**
-   Clone the Repository from GitHub
+1. **Download and Unzip Project:**
+    Download project zip from the repository.
 
-2. **Open the Project:**  
-   Open your IDE and select **File > Open Folder**, navigating to the root folder of the project (containing `pom.xml`).
+2. **Navigate to Project Folder:**
+    Navigate to project folder in the terminal.
+
+    ```bash
+    cd path/to/project/     (linux + mac)
+    cd path\to\project\     (windows)
+    ```
 
-3. **Build the Project:**  
-   Open the terminal in your IDE (`Ctrl + ~`) and run:  
+3. **Run the Application:**
+    Start the program by running the main class:
+
+    ```bash
+    mvn javafx:run
+    ```
+    ```
 
-   ```bash
-   mvn clean compile
-   
-4. **Run the Application:**
-  Start the program by running the main class:
 
+**Run From JAR:     (Windows)
+
+1. Download Project JAR:
+    Go to repository and download the JAR.
+
+2. Run the JAR in Terminal:
     ```bash
-   mvn javafx:run
-   
-5. **Input and Output**
+    java --module-path "path\to\javafx\sdk" --add-modules javafx.controls -jar path\to\jar.jar
+
 
 - Input: User interactions (login, organization selection, donation amount)
 - Output: JavaFX UI displaying organizations, user profiles, donation confirmations
@@ -273,7 +274,6 @@ Each report includes:
    3. Execution times
    4. Running tests in an IDE
 
-[//]: # (TODO: Describe how to run the tests here.)
 
 ## References 🔗