diff --git a/README.md b/README.md index ac54a61..15bdbf7 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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