Skip to content

Commit

Permalink
Merge pull request #83 from Group-5/chore/update/readme-final-touches
Browse files Browse the repository at this point in the history
chore[README]: add guide to generate and access javadoc html
  • Loading branch information
emilfa authored Apr 24, 2026
2 parents 672ec96 + 271d9a3 commit 6fe3a88
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ The project uses the standard Maven directory structure, which ensures:
**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:

Expand Down Expand Up @@ -273,6 +273,19 @@ 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 🔗

For more references and project details, kindly refer yourself to the project report and Wiki pages
Expand Down

0 comments on commit 6fe3a88

Please sign in to comment.