diff --git a/README.md b/README.md index d6e6fd1..73d5cbf 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,18 @@ Advice for common issues with Gradle: - Ensure tools.jar is visible in your Java installation folder. This may require installing JDK8 and moving the tools.jar file from the lib directory into your JRE's lib directory. - Ensure Gradle is visible on your build path, and its file location is set in your computer's environmental variables. +# Documentation + +- [Requirements](/pages/requirements.md) page includes descriptions for several aspects of our project, including but not limited to the projects purpose, details on implementation and dependencies, and performance requirements. + +- [Architecture](/pages/architecture.md) page contains a description on the architecture of our project, including a UML diagram of our project structure. + +- [Design](/pages/design.md) page goes into more detail on the architecture of our project, including brief explainations of the purpose of each class. + +- [Test Report](/pages/testreport.md) page goes into detail on what our requirements were, and are, for testing new features, including component, system, and acceptance testing. + +- [User Stores](/pages/userstories.md) page details all of the functional requirements for our project, as well as desired functions. + # Repository Navigation - .gradle Build file diff --git a/pages/requirements.md b/pages/requirements.md index ee654b9..3ce2c22 100644 --- a/pages/requirements.md +++ b/pages/requirements.md @@ -72,33 +72,45 @@ User must be running JDK version 17 and have the latest version of gradle downlo ## 4.2 Performance Requirements - 1. Gameplay - 4.2.1 Process user input in timely manner. - 4.2.2 Quick response time for in-game processes. - 4.2.3 Error-free and seamless experience. +1. Gameplay - 2. Deliverable (INP) - 4.2.4 Project is able to be installed and deployed to end-users, error-free. + 4.2.1 Process user input in timely manner. + + 4.2.2 Quick response time for in-game processes. + + 4.2.3 Error-free and seamless experience. + +2. Deliverable (INP) + + 4.2.4 Project is able to be installed and deployed to end-users, error-free. ## 4.3 Design Constraints - 1. Software Constraints - 4.3.1 Installation of Java Development Kit and Gradle is required to build and run project. - 4.3.2 Latest version of Java Development Kit (v.20) incompatible with latest version of Gradle (8). JDK 17 or earlier required for builds with Gradle 8. +1. Software Constraints + + 4.3.1 Installation of Java Development Kit and Gradle is required to build and run project. + + 4.3.2 Latest version of Java Development Kit (v.20) incompatible with latest version of Gradle (8). JDK 17 or earlier required for builds with Gradle 8. - 2. Hardware Constraints - No significant hardware constraints. +2. Hardware Constraints - No significant hardware constraints. ## 4.4 Quality Requirements - 1. Usability - 4.4.1 Concise and informative documentation. - 4.4.2 Easy to maintain and update. - 4.4.3 Intuitive design and interface. +1. Usability + + 4.4.1 Concise and informative documentation. + + 4.4.2 Easy to maintain and update. + + 4.4.3 Intuitive design and interface. - 2. End-to-end Progression (INP) - 4.4.4 Multiple explorable rooms with enemy sprites and loot. - 4.4.5 Items from previous rooms required to progress to next room. - 4.4.6 Final room with a 'boss' enemy. +2. End-to-end Progression (INP) + + 4.4.4 Multiple explorable rooms with enemy sprites and loot. + + 4.4.5 Items from previous rooms required to progress to next room. + + 4.4.6 Final room with a 'boss' enemy. ## 4.5 Other Requirements