Skip to content

Commit

Permalink
Merge pull request #139 from jinzihan2002/Zihan-7-Nov-2
Browse files Browse the repository at this point in the history
Add page breaks to format UG
  • Loading branch information
jinzihan2002 authored Nov 7, 2024
2 parents c7afcd2 + 7b05259 commit f1a9993
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Your command terminal should look similar to the one below.
![tutorlink_startup.png](tutorlink_startup.png)
## Features

<div style="page-break-after: always;"></div>

### Adding a Student: `add_student`

Adds a student to your class.
Expand Down Expand Up @@ -53,6 +55,8 @@ Displays a list of all students in the class.

---

<div style="page-break-after: always;"></div>

### Finding a Student: `find_student`

Adds a student to your class.
Expand Down Expand Up @@ -94,6 +98,8 @@ Removes an existing grading component from the class.

---

<div style="page-break-after: always;"></div>

### Listing Components: `list_component`

Displays all grading components and their respective weights for a class.
Expand Down Expand Up @@ -133,6 +139,8 @@ Removes a previously recorded grade for a specific student and component.

---

<div style="page-break-after: always;"></div>

### Listing Grades: `list_grade`

Views all recorded grades for a specific student or all students, and final percentage calculation. If the weightage of components does not add up to 100% (i.e., the course is still in progress), "IP" (In Progress) will be shown instead of a final percentage.
Expand Down Expand Up @@ -168,6 +176,9 @@ The data from the student, component and grade lists are stored in `studentlist.
respectively, located in the `[JAR file location]/data/` directory.

---

<div style="page-break-after: always;"></div>

## Notes:
- Matric Number (`i/` argument) is case insensitive. Therefore, `A1234567X` is the same as `a1234567x`. Matric numbers
will be converted to uppercase for storage.
Expand All @@ -187,6 +198,8 @@ unless you are confident you can do so correctly.

---

<div style="page-break-after: always;"></div>

## Command Summary

| **Command** | **Description** | **Example** |
Expand Down

0 comments on commit f1a9993

Please sign in to comment.