diff --git a/README.md b/README.md index 66305b45b8a..af2eba06b1d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![codecov](https://codecov.io/gh/AY2324S1-CS2103T-W08-2/tp/graph/badge.svg?token=DAJLBHDPYQ)](https://codecov.io/gh/AY2324S1-CS2103T-W08-2/tp) # Modulight -![Ui](docs/images/Ui_navigate.png) +![Ui](docs/images/Ui.png) Modulight is a **Desktop application for managing student grades**. It is a system to track students and their performance on graded components, utility functions to get statistics on the cohort and certain subgroups. diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 99e7f7a11b3..0379095dd5e 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -154,7 +154,7 @@ The following section gives an overview of the parameters used for the commands | Parameter | Description | Constraints | Valid Examples | Invalid Examples | |-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|-----------------------------| -| INDEX | Used in [edit commands](#edit-commands) and [delete commands](#delete-commands), The [index](#glossary) of the target student, score or component | Positive integer | 1, 10, 21 | -2, 0, 03 | +| INDEX | Used in [edit commands](#edit-commands) and [delete commands](#delete-commands), The [index](#glossary) of the target student, score or component | Positive integer | 1, 10, 21 | -2, 0 | | o/ | Used in the [sortStu](#sorting-students-sortstu) command, the selected parameter of students to be sorted | Only parameters in the list (The full list can be found under the description of [sortStu](#sorting-students-sortstu) command) are allowed | n, totalscore, tut | studentName, overall score | | r/ | Used in the [sortStu](#sorting-students-sortstu) and [sortStuScore](#sorting-students-scores-sortscore) commands, the reverse order (to arrange the list either in ascending or descending order) | Only parameters in the list (The full list can be found under the description of [sortStu](#sorting-students-sortstu) and [sortScore](#sorting-students-scores-sortscore) commands) are allowed | t, f, decreasing | True, ascending | | st/ | Used in the [stats](#calculating-overall-statistics-stats) and [compStats](#calculating-statistics-of-a-graded-component-compstats) commands, the statistical measures to be calculated | Only parameters in the list (The full list can be found under the description of [stats](#calculating-overall-statistics-stats) and [compStats](#calculating-statistics-of-a-graded-component-compstats) commands) are allowed | max, upperQuartile | quartile, correlation | @@ -189,7 +189,7 @@ The following section gives an overview of the parameters used for the commands ModuLight comes with a GUI to allow for nice visual feedback for our users. Here is a quick run through of the different sections of our GUI, as well as some notes regarding the use of the GUI. ### Quick Orientation: -![Ui overview](images/Ui_navigate.png) +![Ui overview](images/Ui.png) Here is a summary of each GUI component within ModuLight. diff --git a/docs/images/Ui.png b/docs/images/Ui.png index 27d2a3ffe9f..39a9528467f 100644 Binary files a/docs/images/Ui.png and b/docs/images/Ui.png differ diff --git a/docs/images/Ui_navigate.png b/docs/images/Ui_navigate.png deleted file mode 100644 index 39a9528467f..00000000000 Binary files a/docs/images/Ui_navigate.png and /dev/null differ