[Teo Jia Rong] iP

.gitignore

@@ -15,3 +15,5 @@ bin/
 
 /text-ui-test/ACTUAL.txt
 text-ui-test/EXPECTED-UNIX.TXT
+duke.txt
+potaton.txt

docs/README.md

@@ -1,29 +1,197 @@
-# User Guide
-
+# User Guide for Potaton
+Your personal chatbot for task tracking.
 ## Features 
+- Add tasks to be tracked
+- Various task types (Event, Deadlines, ToDos)
+- List and view all tasks
+- Mark and unmark tasks
+- Search for tasks
+- Deletion of tasks
+
+## Before Starting
+1. Ensure that you have installed Java 11 or above.
+2. Download latest Potaton.jar from [releases](https://github.com/tjiarong/ip/releases).
+3. Copy the file to the folder you want to use as the _home folder_ for Potaton.
+4. Open a terminal in that folder and launch Potaton by entering `java -jar Potaton.jar`.
+5. Type your commands to Potaton and press Enter to execute.
+6. Refer to the [Usage](#Usage) below for details of each command.
 
-### Feature-ABC
+## Usage
 
-Description of the feature.
+### `todo` - Add a new Todo task
 
-### Feature-XYZ
+Adds a new task with an action.
+The keyword `todo` is used with a short description of the task.
 
-Description of the feature.
+Format: `todo DESCRIPTION`
 
-## Usage
+**Example usage:**
+
+`todo Buy groceries`
+
+**Expected outcome:**
+```
+_____________________________________________
+Got it. I've added this task
+[T][ ] Buy groceries
+_____________________________________________
+```
+
+### `deadline` - Add a new Deadline task
+
+Adds a new Deadline with a due date.
+The keyword `deadline` is followed by a short description 
+and a delimiter of `/by` followed by the due date in YYYY-MM-DD format.
+
+Format: `deadline DESCRIPTION /by DUEDATE`
+
+**Example usage:**
+
+`deadline Assignment 1 /by 2022-03-28`
+
+**Expected outcome:**
+```
+_____________________________________________
+Got it. I've added this task
+[D][ ] Assignment (by: Mar 28 2022)
+_____________________________________________
+```
+
+### `event` - Add a new Event task
+
+Adds a new Event with a start date.
+The keyword `event` is followed by a short description
+and a delimiter of `/at` followed by the due date in YYYY-MM-DD format.
+
+Format: `event DESCRIPTION /at EVENTDATE`
+
+**Example usage:**
+
+`event Annual Party /at 2022-05-05`
+
+**Expected outcome:**
+```
+_____________________________________________
+Got it. I've added this task
+[E][ ] Annual (at: May 5 2022)
+_____________________________________________
+```
+
+### `list` - List out task list
+
+Prints out the task list. Each entry shows the task index, task type,
+its status and its description,
+
+Format: `list`
+
+**Example usage:**
+
+`list`
+
+**Expected outcome (task list from before):**
+```
+_____________________________________________
+   Here are the tasks in your list:
+1. [T][ ] Buy groceries
+2. [D][ ] Assignment (by: Mar 28 2022)
+3. [E][ ] Annual (at: May 5 2022)
+_____________________________________________
+```
+
+### `delete` - Deletes task
+
+Deletes a specific task from the task list using its index.
+The task is shown before removal.
+
+Format: `delete INDEX`
+
+**Example usage:**
+
+`delete 2`
+
+**Expected outcome (assuming same example from `list`):**
+```
+_____________________________________________
+Noted. I've removed this task:
+[D][ ] Assignment (by: Mar 28 2022)
+_____________________________________________
 
-### `Keyword` - Describe action
+```
 
-Describe the action and its outcome.
+### `find` - Search for task
 
-Example of usage: 
+Search for task matching a particular term. All matching
+task will be displayed.
 
-`keyword (optional arguments)`
+Format: `find TERM`
 
-Expected outcome:
+**Example usage:**
 
-Description of the outcome.
+`find groceries`
 
+**Expected outcome (assuming same example from `list`):**
 ```
-expected output
+_____________________________________________
+Here are the matching tasks in your list:
+[T][ ] Buy groceries
+_____________________________________________
 ```
+
+### `mark`/`unmark` - Mark or unmark a task as Done/Not Done
+
+Mark or unmark a task as Done or Not Done using its list index.
+Users should verify the task index using `list` before removal.
+
+A character `X` denotes the task as Done.
+
+Format: `mark INDEX / unmark INDEX`
+
+**Example usage:**
+
+`mark 1`
+
+**Expected outcome (assuming same example from `list`):**
+```
+_____________________________________________
+Nice! I've marked this task as done:
+[T][X] Buy groceries
+_____________________________________________
+```
+
+### `bye` - Exits the program
+
+Get out of the chatbot
+
+Format: `bye`
+
+**Example usage:**
+
+`bye`
+
+**Expected outcome:**
+```
+_____________________________________________
+Bye. Hope to see you again soon!
+_____________________________________________
+```
+---
+
+## FAQ
+__Q__: How do I transfer my data to another Computer?
+
+__A__: Download Potaton in the other computer and overwrite the empty data file it creates with the
+file that contains the data of the Potaton home folder that you wish to import.
+
+---
+## Command Summary
+
+- All dates are to be in YYYY-MM-DD format
+
+| Action | Format                                                                                     |
+|--------|--------------------------------------------------------------------------------------------|
+| Add    | `todo TASK` <br/>`deadline DESCRIPTION /by DUEDATE` <br/>`event DESCRIPTION /at EVENTDATE` |
+| List   | `list`                                                                                     |
+| Delete | `delete INDEX`                                                                             |
+| Find   | `find TERM`                                                                                |
+| Mark   | `mark INDEX`<br/>`unmark INDEX`                                                            |
+| Exit   | `bye`                                                                                      |

src/main/java/META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: potaton.Potaton
+

src/main/java/potaton/Potaton.java

@@ -0,0 +1,20 @@
+package potaton;
+
+import potaton.controller.Parser;
+import potaton.controller.UI;
+
+public class Potaton {
+
+    /**
+     * The chatbot itself, calls upon other classes to
+     * function.
+     * @param args
+     */
+    public static void main(String[] args){
+        UI.printWelcomeMessage();
+        Parser.parseUserCommand();
+        UI.printByeMessage();
+        System.out.println("Hello");
+        System.out.println("Goodnight");
+    }
+}

src/main/java/potaton/controller/Parser.java

@@ -0,0 +1,38 @@
+package potaton.controller;
+
+import potaton.task.Task;
+
+import java.util.ArrayList;
+import java.util.Scanner;
+
+public class Parser {
+
+    /**
+     * Creates an array list of task. Attempts to
+     * parse content from save file and start
+     * taking in user input.
+     */
+    public static void parseUserCommand() {
+        ArrayList<Task> tasks = new ArrayList<>();
+        Storage.loadFileContent(tasks);
+        Scanner in = new Scanner(System.in);
+        String line = in.nextLine();
+        executeUserCommand(tasks, in, line);
+        Storage.saveContentToFile(tasks);
+    }
+
+    /**
+     * Takes in user input and executes as command
+     * until user enters exit command
+     * @param tasks - list of tasks
+     * @param in - Scanner object
+     * @param line - User input to be parsed
+     */
+    private static void executeUserCommand(ArrayList<Task> tasks, Scanner in, String line) {
+        while (!line.equals(UI.EXIT)) {
+            TaskList.executeCommand(tasks, line.trim());
+            line = in.nextLine();
+        }
+    }
+
+}