Branch a java doc

README.md

@@ -1,24 +1,150 @@
-# Duke project template
+# Arsdorint chatbot
 
-This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
+This is Arsdorint chatbot, a member of Arsdorint Team, and an adaptation application of CS2113 Project Duke) 
 
-## Setting up in Intellij
+## User Guide
 
-Prerequisites: JDK 11, update Intellij to the most recent version.
+1. To download the application, click on this link.
+2. The chatbot contains the following feature
+ + List
+ + Todo
+ + Deadline
+ + Event
+ + Mark
+ + Unmark
+ + Date
+ + Find
+ + Bye
 
-1. Open Intellij (if you are not in the welcome screen, click `File` > `Close Project` to close the existing project first)
-1. Open the project into Intellij as follows:
-   1. Click `Open`.
-   1. Select the project directory, and click `OK`.
-   1. If there are any further prompts, accept the defaults.
-1. Configure the project to use **JDK 11** (not other versions) as explained in [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk).<br>
-   In the same dialog, set the **Project language level** field to the `SDK default` option.
-3. After that, locate the `src/main/java/Duke.java` file, right-click it, and choose `Run Duke.main()` (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see something like the below as the output:
+## Feature - List
+- This function will list all the tasks inputed by the user.
+- Example: 
+>>> list
+Here are the tasks in your list:
+
+____________________________________________________________
+____________________________LIST____________________________
+1.[T][ ] midterm
+	Now you have 1 task in the list.
+____________________________________________________________
+
+
+## Feature - Todo
+- This function will add a task that the user want to do, with a tickbox to mark if the task is done yet or not.
+- Example:
+>>> todo midterm
+____________________________________________________________
+
+Got it. I've added this task:
+
+[T][ ] midterm
+	Now you have 1 task in the list.
+____________________________________________________________
+
+
+## Feature - Deadline
+- This function will add a deadline that the user need to complete, with a tickbox to mark if the deadline is finished or not.
+- Example:
+>>> deadline midterm /by tommorrow
+____________________________________________________________
+
+Got it. I've added this task:
+
+[D][ ] midterm	(by tommorrow)
+	Now you have 2 tasks in the list.
+____________________________________________________________
+
+or 
+>>> deadline midterm /2023-03-04
+____________________________________________________________
+
+Got it. I've added this task:
+
+[D][ ] midterm	(4 Mar 2023)
+	Now you have 4 tasks in the list.
+____________________________________________________________
+
+## Feature - Event
+- This function will add an event that the user need to attend, with a tickbox to mark if the user have attended or not.
+- Example:
+>>> event Open House /on Sunday
+____________________________________________________________
+
+Got it. I've added this task:
+
+[E][ ] Open House	(on Sunday)
+	Now you have 5 tasks in the list.
+____________________________________________________________
+
+or
+>>> event NUS football match /2023-03-05
+____________________________________________________________
+
+Got it. I've added this task:
+
+[E][ ] NUS football match	(5 Mar 2023)
+	Now you have 6 tasks in the list.
+____________________________________________________________
+
+## Feature - Mark
+- This function will mark a task as done by tick a "X" into the tickbox.
+- Example:
+>>> mark 2
+____________________________________________________________
+
+Got it. I've marked this task as done:
+
+[D][X] midterm	(by tommorrow)
+	Now you have 5 unmarked tasks in the list.
+____________________________________________________________
+
+## Feature - Unmark
+- This function will mark a task as not done yet by leaving the tickbox empty.
+- Example: 
+>>> unmark 2
+____________________________________________________________
+
+Got it. I've marked this task as not done yet:
+
+[D][ ] midterm	(by tommorrow)
+	Now you have 0 marked tasks in the list.
+____________________________________________________________
+
+## Feature - Date
+- This function will find if a date is in the task list yet. The date should be in the format of YYYY-MM-DD with YYYY is the year, MM is the month and DD is the day.
+- Example:
+>>> date /2023-03-04
+____________________________________________________________
+1 task happen on this date
+____________________________________________________________
+
+## Feature - Find
+- This function will find if the task the user want to search is in the list yet, and list all task with that name
+- Example:
+>>> find Open House
+____________________________________________________________
+Here are the matching tasks in your list, with 1 task as followed:
+[E][ ] Open House	(at Sunday)
+
+____________________________________________________________
+
+## Feature - Bye
+ - This function will help the chatbot to say bye to the user, and end up the conversation.
+ - Example: 
+ >>> bye
+____________________________________________________________
+ Bye. Hope to see you again soon!
+
+
+____________________________________________________________
+
+### That's all about Arsdorint chatbot! Hope you enjoy our product, and leave some comments to help us improve the chatbot! Thank you so much!
    ```
    Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
+        ___                         _                                 _
+       / _ \     _____   _____  ___| |   ___    _____   _   _____   _| |_
+      / /_\ \   /  ___| /  __/ /  _  |  / _ \  /  ___| | | |  _  \ |_   _|
+     / _____ \  | /    __\ \   | |_| | | |_| | | /     | | | | | |   | |
+    /_/     \_\ |_|   /____/   \_____|  \___/  |_|     |_| |_| |_|   |_|
+
    ```

docs/README.md

@@ -1,29 +1,184 @@
-# User Guide
+# Arsdorint chatbot
 
-## Features 
+This is Arsdorint chatbot, a member of Arsdorint Team, and an adaptation application of CS2113 Project Duke) 
 
-### Feature-ABC
+## User Guide
 
-Description of the feature.
+1. To download the application, click [here](https://github.com/arsdorintbp2003/ip/releases/tag/A-Released).
+2. Copy the file path after your download. (ie: C:\Users\YourPC\GitHub\ip_jar)
+3. Open your terminal, if the current path is not where you keep the file (ie: C:\Users\YourPC), just type `cd` + the remaining path (ie: 'cd GitHub\ip_jar`) to access the file path.
+4. Initializing the application by typing `java -jar ip.jar`, and enjoy using the chatbot. 
+5. The chatbot contains the following feature
+ + List
+ + Todo
+ + Deadline
+ + Event
+ + Mark
+ + Unmark
+ + Date
+ + Find
+ + Bye
 
-### Feature-XYZ
+## Feature - List
+- This function will list all the tasks inputed by the user.
+- Example: 
 
-Description of the feature.
+```
+>>> list
+Here are the tasks in your list:
+
+____________________________________________________________
+____________________________LIST____________________________
+1.[T][ ] midterm
+	Now you have 1 task in the list.
+____________________________________________________________
+```
+
+## Feature - Todo
+- This function will add a task that the user want to do, with a tickbox to mark if the task is done yet or not.
+- Example:
+
+```
+>>> todo midterm
+____________________________________________________________
+
+Got it. I've added this task:
+
+[T][ ] midterm
+	Now you have 1 task in the list.
+____________________________________________________________
+```
+
+## Feature - Deadline
+- This function will add a deadline that the user need to complete, with a tickbox to mark if the deadline is finished or not.
+- Example:
+
+```
+>>> deadline midterm /by tommorrow
+____________________________________________________________
 
-## Usage
+Got it. I've added this task:
+
+[D][ ] midterm	(by tommorrow)
+	Now you have 2 tasks in the list.
+____________________________________________________________
+```
+
+or 
 
-### `Keyword` - Describe action
+```
+>>> deadline midterm /2023-03-04
+____________________________________________________________
 
-Describe the action and its outcome.
+Got it. I've added this task:
+
+[D][ ] midterm	(4 Mar 2023)
+	Now you have 4 tasks in the list.
+____________________________________________________________
+```
 
-Example of usage: 
+## Feature - Event
+- This function will add an event that the user need to attend, with a tickbox to mark if the user have attended or not.
+- Example:
 
-`keyword (optional arguments)`
+```
+>>> event Open House /on Sunday
+____________________________________________________________
 
-Expected outcome:
+Got it. I've added this task:
+
+[E][ ] Open House	(on Sunday)
+	Now you have 5 tasks in the list.
+____________________________________________________________
+```
 
-Description of the outcome.
+or
 
 ```
-expected output
+>>> event NUS football match /2023-03-05
+____________________________________________________________
+
+Got it. I've added this task:
+
+[E][ ] NUS football match	(5 Mar 2023)
+	Now you have 6 tasks in the list.
+____________________________________________________________
 ```
+
+## Feature - Mark
+- This function will mark a task as done by tick a "X" into the tickbox.
+- Example:
+
+```
+>>> mark 2
+____________________________________________________________
+
+Got it. I've marked this task as done:
+
+[D][X] midterm	(by tommorrow)
+	Now you have 5 unmarked tasks in the list.
+____________________________________________________________
+```
+
+## Feature - Unmark
+- This function will mark a task as not done yet by leaving the tickbox empty.
+- Example: 
+
+```
+>>> unmark 2
+____________________________________________________________
+
+Got it. I've marked this task as not done yet:
+
+[D][ ] midterm	(by tommorrow)
+	Now you have 0 marked tasks in the list.
+____________________________________________________________
+```
+
+## Feature - Date
+- This function will find if a date is in the task list yet. The date should be in the format of YYYY-MM-DD with YYYY is the year, MM is the month and DD is the day.
+- Example:
+
+```
+>>> date 2022-03-04
+____________________________________________________________
+1 task occurs on this date:
+[D][ ] Open House       (4 Mar 2022)
+```
+
+## Feature - Find
+- This function will find if the task the user want to search is in the list yet, and list all task with that name
+- Example:
+
+```
+>>> find Open House
+____________________________________________________________
+Here are the matching tasks in your list, with 1 task as followed:
+[E][ ] Open House	(on Sunday)
+
+____________________________________________________________
+```
+
+## Feature - Bye
+ - This function will help the chatbot to say bye to the user, and end up the conversation.
+ - Example: 
+
+ ```
+ >>> bye
+____________________________________________________________
+ Bye. Hope to see you again soon!
+
+
+____________________________________________________________
+```
+
+### That's all about Arsdorint chatbot! Hope you enjoy our product, and leave some comments to help us improve the chatbot! Thank you so much!
+   ```
+   Hello from
+        ___                         _                                 _
+       / _ \     _____   _____  ___| |   ___    _____   _   _____   _| |_
+      / /_\ \   /  ___| /  __/ /  _  |  / _ \  /  ___| | | |  _  \ |_   _|
+     / _____ \  | /    __\ \   | |_| | | |_| | | /     | | | | | |   | |
+    /_/     \_\ |_|   /____/   \_____|  \___/  |_|     |_| |_| |_|   |_|
+
+   ```