forked from nus-cs2103-AY2425S1/tp
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
6 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,8 +6,8 @@ | |
|
|
||
| # TAchy User Guide | ||
|
|
||
| TAchy is a **desktop app for managing students, optimized for use via a Line Interface** (CLI) while | ||
| still having the benefits of a Graphical User Interface (GUI). If you can type fast, TAchy can get your student | ||
| TAchy is a **desktop app for managing students, optimized for use via a Line Interface** (CLI) while | ||
| still having the benefits of a Graphical User Interface (GUI). If you can type fast, TAchy can get your student | ||
| management tasks done faster than traditional GUI apps. | ||
|
|
||
| <!-- * Table of Contents --> | ||
|
|
@@ -23,7 +23,7 @@ management tasks done faster than traditional GUI apps. | |
|
|
||
| 1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook. | ||
|
|
||
| 1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar TAchy.jar` command to | ||
| 1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar TAchy.jar` command to | ||
| run the application.<br> | ||
| A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br> | ||
|  | ||
|
|
@@ -33,7 +33,7 @@ management tasks done faster than traditional GUI apps. | |
|
|
||
| * `list` : Lists all students. | ||
|
|
||
| * `add_student n/John Doe p/98765432 e/[email protected] ` : Adds a student named | ||
| * `add_student n/John Doe p/98765432 e/[email protected] ` : Adds a student named | ||
| `John Doe` to the app. | ||
|
|
||
| * `delete 3` : Deletes the 3rd student shown in the current list. | ||
|
|
@@ -156,7 +156,7 @@ Adds an Assignment to the app. | |
| Format: `add_assignment studentIndex/STUDENT_INDEX assignmentName/ASSIGNMENT_NAME maxScore/MAX_SCORE` | ||
|
|
||
| Examples: | ||
| * `list` followed by `add_assignment studentIndex/3 assignmentName/Assignment 1 maxScore/100` adds an assignment to the | ||
| * `list` followed by `add_assignment studentIndex/3 assignmentName/Assignment 1 maxScore/100` adds an assignment to the | ||
| 3rd student in the app. | ||
| * `add_assignment studentIndex/1 assignmentName/Assignment 1 maxScore/100` | ||
|
|
||
|
|
@@ -261,4 +261,4 @@ Action | Format, Examples | |
| **Delete Assignment** | `delete_assignment studentIndex/INDEX assignmentIndex/INDEX`<br> e.g., `delete_assignment studentIndex/1 assignmentIndex/1` | ||
| **Mark Assignment** | `mark studentIndex/INDEX assignmentIndex/INDEX`<br> e.g., `mark studentIndex/1 assignmentIndex/1` | ||
| **Unmark Assignment** | `unmark studentIndex/INDEX assignmentIndex/INDEX`<br> e.g., `unmark studentIndex/1 assignmentIndex/1` | ||
| **Grade Assignment** | `grade studentIndex/INDEX assignmentIndex/INDEX score/ASSIGNMENT_SCORE`<br> e.g., `grade studentIndex/1 assignmentIndex/1 score/100` | ||
| **Grade Assignment** | `grade studentIndex/INDEX assignmentIndex/INDEX score/ASSIGNMENT_SCORE`<br> e.g., `grade studentIndex/1 assignmentIndex/1 score/100` | ||