+
-**:information_source: Notes about the command format:**
+**:bulb: Tip**
-* Words in `UPPER_CASE` are the parameters to be supplied by the user.
- e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`.
+`Tips` are used to provide helpful advice, suggestions, or best practices to enhance your experience by making a task easier or more efficient.
-* Items in square brackets are optional.
- e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`.
+
-* Items with `…` after them can be used multiple times including zero times.
- e.g. `[t/TAG]…` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc.
+
-* Parameters can be in any order.
- e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable.
+**:warning: Warning**
-* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
- e.g. if the command specifies `help 123`, it will be interpreted as `help`.
+`Warnings` are used to alert you about potential issues, errors, or risks associated with a task or action. They are essential for preventing mistakes and ensuring safety.
-* If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.
-### Viewing help : `help`
-
-Shows a message explaning how to access the help page.
-
-
+
-Format: `help`
+**:information_source: Information**
+`Information` sections provide additional background knowledge or context to help you understand a topic better.
-### Adding a person: `add`
+
-Adds a person to the address book.
+--------------------------------------------------------------------------------------------------------------------
-Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…`
+## Quick Start
-
:bulb: **Tip:**
-A person can have any number of tags (including 0)
-
+1. Ensure you have Java `11` installed in your Computer. To verify, perform the following steps:
+ 1. Open a terminal. Refer to the following guides on how:
+ 1. [MacOS](https://support.apple.com/en-sg/guide/terminal/apd5265185d-f365-44cb-8b09-71a064a42125/mac#:~:text=Terminal%20for%20me-,Open%20Terminal,%2C%20then%20double%2Dclick%20Terminal)
+ 2. [Windows](https://www.howtogeek.com/235101/10-ways-to-open-the-command-prompt-in-windows-10/#:~:text=anywhere%20you%20like.-,Open%20Command%20Prompt%20from%20the%20Run%20Box,open%20an%20administrator%20Command%20Prompt)
+ 2. Type `java -version` and press Enter.
+ 3. If it says a version other than 11 or `command not found`, please install Java 11 by following this [guide](https://www.java.com/en/download/help/download_options.html).
-Examples:
-* `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01`
-* `add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal`
+2. Download the latest jar file (tutorconnect.jar) from our [Github Releases](https://github.com/AY2324S1-CS2103T-T17-3/tp/releases).
-### Listing all persons : `list`
+3. Move the jar file into a new folder called “Tutor Connect”.
-Shows a list of all persons in the address book.
+4. Double-click the jar file to launch the application.
-Format: `list`
+
+
+ **:information_source: Mac Users**
+
+ If you are a Mac user, you may encounter a warning that says
+ the jar file cannot be opened because it is from an unidentified developer. To continue:
+
+ 1. Right-click on the jar file and select `Open With > JavaLauncher (default)`
+ 2. Press Open when prompted
-### Editing a person : `edit`
+
-Edits an existing person in the address book.
+5. Refer to the [Features](#features) below for details of each command.
-Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
+--------------------------------------------------------------------------------------------------------------------
-* Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, …
-* At least one of the optional fields must be provided.
-* Existing values will be updated to the input values.
-* When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
-* You can remove all the person’s tags by typing `t/` without
- specifying any tags after it.
+## Features
-Examples:
-* `edit 1 p/91234567 e/johndoe@example.com` Edits the phone number and email address of the 1st person to be `91234567` and `johndoe@example.com` respectively.
-* `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags.
+
-### Locating persons by name: `find`
+**:information_source: Command Format:**
-Finds persons whose names contain any of the given keywords.
+* Words in `UPPER_CASE` are the parameters to be supplied by the user.
+ e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`.
+* Items in square brackets are optional.
+ e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`.
+* Items with `…` after them can be used multiple times including zero times.
+ e.g. `[t/TAG]…` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc.
+* Parameters can be in any order.
+ e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable.
+* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`)
+ will be ignored.
+ e.g. if the command specifies `help 123`, it will be interpreted as `help`.
+* If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple
+ lines as space characters surrounding line-breaks may be omitted when copied over to the application.
-Format: `find KEYWORD [MORE_KEYWORDS]`
+
-* The search is case-insensitive. e.g `hans` will match `Hans`
-* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
-* Only the name is searched.
-* Only full words will be matched e.g. `Han` will not match `Hans`
-* Persons matching at least one keyword will be returned (i.e. `OR` search).
- e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang`
+### Adding a tutor: `add-t`
-Examples:
-* `find John` returns `john` and `John Doe`
-* `find alex david` returns `Alex Yeoh`, `David Li`
- 
+Adds a tutor to the address book.
-### Deleting a person : `delete`
+
-Deletes the specified person from the address book.
+Format: `add-t n/NAME p/PHONE NUMBER e/EMAIL`
-Format: `delete INDEX`
+Example:
+* `add-t n/John Doe p/98765432 e/johnd@example.com`
+* `add-t n/Betsy Crowe p/91234567 e/betsycrowe@example.com`
-* Deletes the person at the specified `INDEX`.
-* The index refers to the index number shown in the displayed person list.
-* The index **must be a positive integer** 1, 2, 3, …
+Acceptable values for each parameter:
+* `NAME`: Only string input accepted
+* `PHONE`: NUMBER Only numerical input
+* `EMAIL`: Only valid email addresses
-Examples:
-* `list` followed by `delete 2` deletes the 2nd person in the address book.
-* `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command.
+Expected output:
+* `New tutor John Doe 98765432 johnd@example.com has been added.`
-### Clearing all entries : `clear`
+Error messages:
+* `Missing parameter: n/`: The tag n/ is missing or tutor’s name is missing.
+* `Missing parameter: p/`: The tag p/ is missing or tutor’s phone number is missing.
+* `Missing parameter: e/`: The tag e/ is missing or tutor’s email is missing.
+* `Wrong input: n/`: The name entered is not a valid string.
+* `Wrong input: p/`: The phone number entered does not consist of numbers only.
+* `Wrong input: e/`: The email entered is invalid.
-Clears all entries from the address book.
+### Adding a schedule: `add-s`
-Format: `clear`
+Adds a schedule to a specified tutor.
-### Exiting the program : `exit`
+
-Exits the program.
+**Format**: `add-s ti/TUTOR_INDEX s/START_TIME e/END_TIME`
-Format: `exit`
+**Examples**:
+* `add-s ti/1 s/2023-09-15T09:00:00 e/2023-09-15T11:00:00`
+* `add-s ti/2 s/2023-09-16T17:00:00 e/2023-09-16T19:00:00`
-### Saving the data
+**Acceptable values for each parameter**:
+* `TUTOR_INDEX`: Only number input accepted, starting from 1 to the last tutor index shown in the list of tutors.
+* `START_TIME`: Only datetime in `yyyy-MM-ddTHH:mm:ss` format is accepted
+* `END_TIME`: Only datetime in `yyyy-MM-ddTHH:mm:ss` format is accepted
-AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
+
+
+ **:information_source: Information**
+
+ * `yyyy` represents the **year** (e.g., 2023).
+ * `MM` represents the **month** with a leading zero (e.g., 09 for September, 10 for October).
+ * `dd` represents the **day** of the month with a leading zero (e.g., 03, 15).
+ * `T` is a **separator** indicating the start of the time portion.
+ * `HH` represents the **hour** in **24-hour format** with a leading zero (e.g., 09 for 9 AM, 21 for 9 PM).
+ * `mm` represents the **minutes** with a leading zero (e.g., 05).
+ * `ss` represents the **seconds** with a leading zero (e.g., 05).
+
+
-### Editing the data file
+**Expected output**:
+* `New schedule John Doe starting from Sep 15 2023 09:00 to Sep 15 2023 11:00 has been added.`
-AddressBook data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file.
+**Error messages**:
+* `Missing parameter: ti/`: The tag ti/ is missing or tutor’s index is missing.
+* `Missing parameter: s/`: The tag s/ is missing or schedule’s start time is missing.
+* `Missing parameter: e/`: The tag e/ is missing or the schedule’s end time is missing.
+* `Wrong input: ti/`: The tutor index entered is not a valid number.
+* `Index number given is out of range`: Given index is out of range.
+* `Wrong input: s/`: The start time entered is not in datetime format.
+* `Wrong input: e/`: The end time entered is not in datetime format..
-
:exclamation: **Caution:**
-If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
-
-### Archiving data files `[coming in v2.0]`
_Details coming soon ..._
@@ -186,12 +192,13 @@ _Details coming soon ..._
## Command summary
-Action | Format, Examples
---------|------------------
-**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague`
-**Clear** | `clear`
-**Delete** | `delete INDEX`
e.g., `delete 3`
-**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
e.g.,`edit 2 n/James Lee e/jameslee@example.com`
-**Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake`
-**List** | `list`
-**Help** | `help`
+| Action | Format, Examples |
+|------------------|-----------------------------------------------------------------------------------------------------------------------------|
+| **Add Tutor** | `add-t n/NAME p/PHONE NUMBER e/EMAIL`
e.g., `add-t n/John Doe p/98765432 e/johnd@example.com` |
+| **Add Schedule** | `add-s ti/TUTOR_INDEX s/START_TIME e/END_TIME`
e.g., `add-s ti/1 s/2023-09-15T09:00:00 e/2023-09-15T11:00:00` |
+| **Clear** | `clear` |
+| **Delete** | `delete INDEX`
e.g., `delete 3` |
+| **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` |
+| **Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` |
+| **List** | `list` |
+| **Help** | `help` |
diff --git a/docs/images/Ui.png b/docs/images/Ui.png
index 5bd77847aa2..876267cb029 100644
Binary files a/docs/images/Ui.png and b/docs/images/Ui.png differ
diff --git a/docs/images/addSchedule.png b/docs/images/addSchedule.png
new file mode 100644
index 00000000000..a2f7debb806
Binary files /dev/null and b/docs/images/addSchedule.png differ
diff --git a/docs/images/addTutor.png b/docs/images/addTutor.png
new file mode 100644
index 00000000000..55ae74d6386
Binary files /dev/null and b/docs/images/addTutor.png differ
diff --git a/docs/images/dishenggg.png b/docs/images/dishenggg.png
new file mode 100644
index 00000000000..1ce7ce16dc8
Binary files /dev/null and b/docs/images/dishenggg.png differ
diff --git a/docs/images/jweng88.png b/docs/images/jweng88.png
new file mode 100644
index 00000000000..1ce7ce16dc8
Binary files /dev/null and b/docs/images/jweng88.png differ
diff --git a/docs/images/mfjkri.png b/docs/images/mfjkri.png
new file mode 100644
index 00000000000..1ce7ce16dc8
Binary files /dev/null and b/docs/images/mfjkri.png differ
diff --git a/docs/images/ruishanteo.png b/docs/images/ruishanteo.png
new file mode 100644
index 00000000000..1ce7ce16dc8
Binary files /dev/null and b/docs/images/ruishanteo.png differ
+
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/jweng88)]
+[[portfolio](team/jweng88.md)]
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Tutor deletion, Tutor viewing
-### Jane Doe
+### Muhammad Fikri
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/mfjkri)]
+[[portfolio](team/mfjkri.md)]
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Tutor search
### Johnny Doe
@@ -38,22 +38,22 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
* Role: Developer
* Responsibilities: Data
-### Jean Doe
+### Teo Rui Shan
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/ruishanteo)]
+[[portfolio](team/ruishanteo.md)]
* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Add Tutors functionalities
-### James Doe
+### Yeo Di Sheng
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/dishenggg)]
+[[portfolio](team/dishenggg.md)]
* Role: Developer
-* Responsibilities: UI
+* Responsibilities: Add schedule
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index 57437026c7b..755aae6e23a 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -3,169 +3,175 @@ layout: page
title: User Guide
---
-AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps.
+## Welcome to Tutor Connect
-* Table of Contents
-{:toc}
-
---------------------------------------------------------------------------------------------------------------------
-
-## Quick start
-
-1. Ensure you have Java `11` or above installed in your Computer.
-
-1. Download the latest `addressbook.jar` 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. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar addressbook.jar` command to run the application.