Merge pull request #234 from avrilmohh/update-user-guide-3

Modify quick start and add constraint for add assignment and view student command

docs/UserGuide.md

@@ -19,12 +19,19 @@ management tasks done faster than traditional GUI apps.
 
 1. Ensure you have Java `17` or above installed in your Computer.
 
-1. Download the latest `.jar` file from [here](https://github.com/se-edu/addressbook-level3/releases).
+1. Download the latest `TAchy.jar` file from [here](https://github.com/se-edu/addressbook-level3/releases).
 
-1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook.
+1. Copy the file to the folder you want to use as the _home folder_ for TAchy.
 
 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>
+   run the application. 
+<br> By default, it should be saved in your Downloads folder. <br>
+   - For Windows users: Type `cd Downloads`, and press `Enter`.
+   - For MacOS users: Type `cd ~/Downloads`, and press `Enter`.
+   - For Linux users: Type `cd ~/Downloads`, and press `Enter`.
+
+1. Type the command `java -jar TAchy.jar` into the terminal 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>
    ![Ui](images/Ui.png)
 
@@ -36,9 +43,13 @@ management tasks done faster than traditional GUI apps.
    * `add_student n/John Doe p/98765432 e/[email protected] ` : Adds a student named
      `John Doe` to the app.
 
-   * `view_student 2 ` : Displays the details of the 2nd student shown in the current list.
+   * `view_student 2` : Displays the details of the 2nd student shown in the current list.
 
    * `delete_student 3` : Deletes the 3rd student shown in the current list.
+
+   * `add_assignment si/1 an/Assignment 1 ms/100` : Adds Assignment 1 to the 1st student in the current list with max score 100.
+
+   * `grade si/1 ai/1 s/100` : Edits the score of the 1st assignment belonging to the 1st student in the current list to be 100.
 
    * `clear` : Deletes all students.
 
@@ -108,6 +119,10 @@ Format: `view_student INDEX`
 ![Explanation for INDEX](images/student_index.png)
 * The index **must be a positive integer** 1, 2, 3, …​
 
+Constraints:
+* Index must exist in the current displayed student list.
+  <box type="tip" seamless>
+
 Examples:
 * `list` followed by `view_student 2` displays the 2nd student in the list.
 * `find Betsy` followed by `view_student 1` displays the 1st student in the results of the `find` command.
@@ -178,10 +193,15 @@ Format: `add_assignment si/STUDENT_INDEX an/ASSIGNMENT_NAME ms/MAX_SCORE`
   displayed student list.
 * The max score must be a positive integer.
 
+Constraints:
+* Assignment name must be at most 256 characters long, and must be alphanumeric
+  <box type="tip" seamless>
+
 Examples:
 * `list` followed by `add_assignment si/3 an/Assignment 1 ms/100` adds an assignment to the
   3rd student in the app.
-* `add_assignment si/1 an/Assignment 1 ms/100`
+* `list` followed by `add_assignment si/1 an/Assignment 1 ms/100` adds an assignment to the
+  1st student in the app.
   ![result for 'add_assignment si/1 an/Assignment 1 ms/100'](images/addAssignment.jpg)
 
 ### Deleting an assignment: `delete_assignment`