Skip to content

Commit

Permalink
chore[README]: add guide to generate and access javadoc html
Browse files Browse the repository at this point in the history
  • Loading branch information
Lucy Ciara Herud-Thomassen authored and Lucy Ciara Herud-Thomassen committed Apr 23, 2026
1 parent 1d94ded commit ae6d4bc
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 🔗

Expand Down

0 comments on commit ae6d4bc

Please sign in to comment.