From ad6d003233e43cb5e9aa5539d039dacdbad640e3 Mon Sep 17 00:00:00 2001 From: Erik Aasen Date: Thu, 23 Apr 2026 14:24:09 +0200 Subject: [PATCH] Update README.md updated read me with how to start the program and view javadoc --- README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 61 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1ed1fee..ff14ec7 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,69 @@ -# Welcome to the "Help Me Help" (HmH) Project Wiki - -**Course:** IDATx1005 Software Engineering 2026 +# Help Me Help (HmH) +**Course:** IDATx1005 Software Engineering 2026 **Group:** 3 --- ## The Team -* **Aksel Kirkhorn** -* **Elisabeth Berg** -* **Erik Aasen** -* **Johanna Krogh Anderson** +- **Aksel Kirkhorn** +- **Elisabeth Berg** +- **Erik Aasen** +- **Johanna Krogh Anderson** + +--- + +## About the Project +Help Me Help (HmH) is a software engineering project developed as part of the course **IDATx1005 Software Engineering 2026**. + +The purpose of the application is to make it easier for users to find and explore charitable organizations in a structured and trustworthy way. + +--- + +## Requirements +Before starting the application, make sure you have the following installed: + +- Java 21 (JDK 21) +- Maven +- A terminal or IDE such as IntelliJ IDEA, PowerShell, Command Prompt, or Terminal + +--- + +## How to Start the Application + +This project uses Maven to build and run the application. + +### Windows +Open **PowerShell** or **Command Prompt** in the project root folder and run: + +```bash +mvn clean javafx:run +``` + +### macOS +Open **Terminal** in the project root folder and run: + +```bash +mvn clean javafx:run +``` --- + +## How to Open Javadoc + +The project Javadoc is available in the `docs/javadoc` folder. + + +### Windows +Open it directly from **PowerShell** or **Command Prompt** in the project file with: + +```powershell +start docs\javadoc\index.html +``` + +### macOS +Open it directly from **Terminal** in the project file with: + +```bash +open docs/javadoc/index.html +```