[Alaukik Pant] iP

_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-hacker

docs/README.md

@@ -1,20 +1,228 @@
-# User Guide
+# [Project Hiroshi](https://github.com/alaukiknpant/duke) - User Guide
 
-## Features 
+By: `Alaukik Nath Pant`      Since: `Feb 2020`      Licence: `MIT`      Course: `CS2113`
 
-### Feature 1 
-Description of feature.
+## Introduction
 
-## Usage
+Hiroshi Nagai Task Tracker(HNTT) is for those who *prefer to use a desktop app for managing their tasks*.
+It is worth noting that HNTT is *optimized for those who prefer to work with a Command Line Interface* (CLI).
+It helps you save todos, events and deadlines.
 
-### `Keyword` - Describe action
+## Quick Start
 
-Describe action and its outcome.
+*  Ensure you have Java `11` or above installed in your Computer.
+*  Download the latest `hiroshi.jar` [latest reslease here!](https://github.com/alaukiknpant/duke/releases/tag/v0.2).
+*  Copy the file to the folder you want to use as the home folder for your Task tracker.
+*  Go to the directory where the Jar file is stored and type: `java -jar Hiroshi.jar`
+* When the application executes, all possible commands that can help you manage your tasks are shown.
+*Some example commands you can try:
+    * **`list`** : lists all tasks that have been added and saved. until now
+    * **`todo`**`finish all your Computer Science homework` : adds a todo task with the corresponding description to the Task List.
+    * **`delete`**`1` : deletes the 1st item in your current task list
+    * **`bye`** : exits the app
 
-Example of usage: 
 
-`keyword (optional arguments)`
+## Features
+
+
+### Command Format
+
+* The words in `UPPER_CASE` are to be supplied by the user e.g. in `todo TASK`, `TASK` is a parameter which can be used to add a task `todo Go Running`.
+* The date for tasks of type `deadline` and `event` are labelled as `DATE`, which is of the format `YYYY-MM-DD`: `deadline TASK \by DATE`, `event TASK \at DATE`.
+* The `TASK_NUMBER` is the interger index of a task in the tasklist and is of the format `delete TASKNUMBER`, `done TASK_NUMBER`.
+* The `KEY_WORD` is the string that you are searching for in the task list.`find food`, `find homework`.
+* The `TASK_NUMBER` refers to the index number shown in the displayed task list. Remember that the index *must be a positive integer* 1, 2, 3, ...
+
+#### Adding a todo task : `todo`
+
+* Adds a todo task to the tasklist 
+* Format: `todo TASK`
+
+[TIP]
+A todo task just needs to be a string but cannot be empty.
+
+Examples:
+
+    todo eat
+
+
+Expected Outcome:
+
+    Got it. I have added this task: 
+
+    [T] [x] eat
+
+    Now you have 2 item/s in the list`
+
+****
+
+#### Adding a deadline task: `deadline `
+
+* Adds a dedline to the tasklist 
+* Format: `deadline TASK /by DATE`
+
+[TIP]
+A deadline task must necessarily have a date mentioned.
+
+Examples:
+
+    deadline eat /by 2019-01-02
+
+Expected Outcome
+
+    Got it. I have added this task: 
+
+    [D] [x] eat (by: Jan 2 2019)
+
+    Now you have 3 item/s in the list
+
+****
+
+#### Adding an `event` task: `event `
+
+* Adds a event to the tasklist
+* Format: `event TASK /at DATE`
+
+[TIP]
+A event task must necessarily have a date mentioned.
+
+Examples:
+
+    event eat /at 2019-01-05
+
+Expected Outcome:
+
+    Got it. I have added this task: 
+
+    [E] [x] eat (at: Jan 5 2019)
+
+    Now you have 3 item/s in the list 
+
+****
+
+#### Deleting a task : `delete`
+
+* Deletes the task at the specified `TASK_NUMBER`. 
+* When a task is deleted, all subsequest tasks in the task list will have their index reduced by 1.
+* Format: `delete TASK_NUMBER`
+
+Examples:
+
+     delete 2
+
+Expected Outcome
+
+    Cool, we will remove the following task:
+    [D] [x] eat (by: Jan 2 2019)
+    Now you have 2 items in your list
+****
+
+#### Listing all tasks in the tasklist : `list`
+
+* Shows a list of all tasks in tasklist.
+* Format: `list`
+
+Examples:
+
+    list
 
 Expected outcome:
 
-`outcome`
+    1. [T] [x] eat
+    2. [E] [x] eat (at: Jan 5 2019)
+
+
+****
+
+#### Marking a task as done : `done`
+
+* Marks the task at the specified `TASK_NUMBER` as done. The task number refers to the index number shown in the displayed task list. Remember that the index *must be a positive integer* 1, 2, 3, ...
+* If a task is already marked as done, the app remarks it as done again.
+* Format: `done TASK_NUMBER`
+
+
+Examples:
+
+    done 2
+
+Expected Outcome:
+
+    2. [E][v] eat (at: Jan 5 2019)
+    Done! We have checked 2!
+
+****
+
+#### Locating a task by key word: `find`
+
+* Finds tasks whose description contains a specified keyword. The search is case sensitive. e.g `run` will not match `Run`
+* Format: `find KEYWORD`
+
+Examples:
+
+    find eat 
+
+Expected Outcome:
+
+    Here are the matching tasks in your list:
+    1. [T] [x] eat
+    2. [E] [v] eat (at: Jan 5 2019)
+
+    There were 2 tasks with the "eat" keyword
+****
+
+#### Clearing the task list : `clear`
+
+* Clears all the tasks in task list.
+* Format: `clear`
+
+Examples:
+
+    clear
+
+Expected Ourcome:
+
+    TaskList is now Empty
+
+****
+
+#### Exiting the program : `bye`
+
+* Exits the program. 
+* Format: `bye`
+
+Examples:
+
+* `bye` 
+
+Expected Ourcome:
+
+    Bye. Hope to see you again soon!
+
+    ****--****--****--****--****--****--****--****--****--****--****--****--****--***
+
+****
+
+## FAQ
+
+*Q*: How do I transfer my data to another Computer? +
+*A*: Copy the text file called "files" that has saved your task list into the directory from which you will run the application in your new computer. You are then set to go!
+
+## Command Summary
+* *Todo*  : `todo TASK`; 
+e.g. `todo Run beside Clementi Park.`
+* *Deadline* : `deadline TASK /by DATE`;
+eg. `deadline Problem Set 2 \by 2020-01-02`
+* *Event* : `event TASK /at DATE`;
+eg. `event Marathon \at 2020-01-01`
+* *List* : `list`
+* *Done* : `done TASK_NUMBER`;
+eg. `done 2`
+* *Delete* : `delete TASK_NUMBER`;
+e.g. `delete 3`
+* *Find* : `find KEYWORD`;
+e.g. `find eat`
+* *Clear* : `clear`
+* *Exit* : `bye`
+
+## Acknowledgement
+My UserGuide has been heavily inspired by the superb format of the AddressBook user guide that we were given access to for this course.

files/TaskList.txt

@@ -0,0 +1 @@
+

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

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: hiroshi.Hiroshi
+

src/main/java/hiroshi/Hiroshi.java

@@ -0,0 +1,64 @@
+package hiroshi;
+
+import hiroshi.commands.Commands;
+import hiroshi.commands.RunCommand;
+import hiroshi.storage.Storage;
+import hiroshi.tasklist.TaskList;
+import hiroshi.tasks.Task;
+import hiroshi.ui.Ui;
+import hiroshi.parser.Parser;
+
+import java.util.ArrayList;
+
+
+/**
+ * <h1>Hiroshi Nagai Task Tracker Chatbot</h1>
+ * Entry point of the "Hiroshi Nagai" Task Tracker application.
+ * Initializes the application and starts the interaction with the user.
+ * <b>Note:</b> This application is written for CS2113 at the NUS School of computing.
+ * @author  Alaukik Nath Pant
+ * @since   2020-02-24
+ */
+public class Hiroshi {
+
+    /** Version info of the program. */
+    public static final String VERSION = "Hiroshi Nagai - Version 2.0";
+
+    private Ui ui;
+    private Storage storage;
+    private TaskList taskList;
+
+    /** Constructor that runs the program.
+     * @param filePath String that represents the relative path to the file that stores all the tasks.
+     */
+    public Hiroshi(String filePath ) {
+        ui = new Ui();
+        taskList = new TaskList();
+        storage = new Storage(filePath);
+        this.run(TaskList.taskList, filePath);
+    }
+
+    /**
+     * Gets the program started by creating a tasklist with the tasks given in the file.
+     * Reads the user command and executes it, until the user issues the exit("bye") command.
+     *
+     * @param taskList List that stores the tasks mentioned until now.
+     * @param filePath String that represents the relative path to the file that stores all the tasks.
+     */
+    public void run(ArrayList<Task> taskList, String filePath) {
+        boolean isExit = false;
+        while (!isExit){
+            String command = Ui.readCommand();
+            RunCommand c = new RunCommand(command, taskList, filePath);
+            c.execute(Commands.finalCommand, taskList, filePath);
+            isExit = c.isExit(Commands.finalCommand);
+        }
+        Ui.printStraightLine();
+        Ui.showByeMessage();
+    }
+
+    public static void main(String[] args) {
+        String filePath = Parser.returnFilePath("files/TaskList.txt");
+        new Hiroshi(filePath);
+       }
+}

src/main/java/hiroshi/commands/AddCommand.java

@@ -0,0 +1,35 @@
+package hiroshi.commands;
+
+import hiroshi.tasklist.AddTasks;
+import hiroshi.tasks.Task;
+import hiroshi.ui.Ui;
+
+import java.util.ArrayList;
+
+/** Represents command that is used to call a method to add tasks to taskList. */
+public class AddCommand extends Commands {
+
+    public AddCommand(String command, ArrayList<Task> taskList, String filePath) {
+        super(command, taskList,filePath);
+    }
+
+    /**
+     * Calls a method to add tasks to taskList and prints the revalent message about the task that has been added.
+     *
+     * @param taskList List that stores the tasks mentioned until now.
+     * @param ogString Original command that was fed to the user.
+     * @param taskType The type of the task to be added, eg: Todo, Event, Deadline.
+     */
+    public static void execute(ArrayList<Task> taskList, String ogString, String taskType) {
+        try {
+            try {
+                AddTasks.execute(taskList, ogString, taskType);
+                Ui.printAddedStatement(taskList);
+            } catch (java.time.format.DateTimeParseException ex) {
+                Ui.markDateTimeException();
+            }
+        } catch (IndexOutOfBoundsException e) {
+            Ui.markAsIncorrectFormat();
+        }
+    }
+}

src/main/java/hiroshi/commands/ClearCommand.java

@@ -0,0 +1,30 @@
+package hiroshi.commands;
+
+import hiroshi.parser.Parser;
+import hiroshi.tasklist.ClearTasks;
+import hiroshi.tasks.Task;
+import hiroshi.ui.Ui;
+
+import java.util.ArrayList;
+
+/** Represents command that is used to call a method to clear all tasks from taskList. */
+public class ClearCommand extends Commands{
+
+    public ClearCommand(String command, ArrayList<Task> taskList, String taskType) {
+        super(command, taskList,taskType);
+    }
+
+    /**
+     * Calls a method to clear all tasks from a taskList.
+     *
+     * @param taskList List that stores the tasks mentioned until now.
+     * @param ogString Original command that was fed to the user.
+     */
+    public static void execute(ArrayList<Task> taskList, String ogString) {
+        if (Parser.isClearStatementCorrect(ogString)) {
+            ClearTasks.execute(taskList);
+            System.out.println("TaskList is now Empty");
+            Ui.printStraightLine();
+        }
+    }
+}