diff --git a/README.md b/README.md index a15b28c..f4eddd7 100644 --- a/README.md +++ b/README.md @@ -213,7 +213,7 @@ https://git.ntnu.no/Group-5/Help-Me-Help **Run From JAR: (Windows) 1. Download Project JAR: - Go to repository and download the JAR. + Go to repository and download the JAR from the jar release. 2. Run the JAR in Terminal: ```bash @@ -274,6 +274,18 @@ Each report includes: 3. Execution times 4. Running tests in an IDE +## Accessing the javadocs +The javadoc can be generated and accessed using the following commands. + +1. Generate the Javadoc HTML + ```bash + mvn javadoc:javadoc + ``` + ``` + ``` + +2. Open the HTML file + open ```target/reports/apidocs/index.html``` ## References 🔗