[Ho Wei Yi Stanley] iP

docs/README.md

@@ -1,20 +1,154 @@
 # User Guide
 
-## Features 
+Welcome! Come and plan your tasks with Duke! :)
 
-### Feature 1 
-Description of feature.
+#### Types of tasks:
 
-## Usage
+1. ToDo
+2. Event
+3. Deadline
 
-### `Keyword` - Describe action
+* [Quick Start](#quick-Start)
+* [Features](#features)
+    * [List all Tasks : `list`](#list-all-tasks--list)
+    * [Add Todo : `todo`](#add-todo--todo)
+    * [Add Event : `event`](#add-event--event)
+    * [Add Deadline : `deadline`](#add-deadline--deadline)
+    * [Delete Task : `delete`](#delete-task--delete)
+    * [Mark Task as Done : `done`](#mark-task-as-done--done)
+    * [Find by Keyword : `find`](#find-by-keyword--find)
+    * [Exit : `bye`](#exit--bye)
+* [Command Summary](#command-summary)
 
-Describe action and its outcome.
+ 
 
-Example of usage: 
+## Quick Start
 
-`keyword (optional arguments)`
+Download `Duke.jar` from
+here: https://github.com/beaniestanley/ip/releases/tag/A-Release
 
-Expected outcome:
+**Requirements:**
 
-`outcome`
+Ensure you have Java 11 or above installed.
+
+**Usage:**
+
+1. Store the .jar file in a folder
+2. Run the .jar file
+3. Enter your command!
+
+ 
+
+## Features
+
+### List all Tasks : `list`
+
+Displays all the tasks currently in your task list.
+
+> `[T]`  Todo<br>
+> `[E]`  Event<br>
+> `[D]`  Deadline<br>
+
+> `[X]`  Done<br>
+> `[ ]`  Not done
+
+**Format:** `list`
+
+| | Example |
+| --------- | ------------------------------------------------------- |
+| Input | `list` |
+| Output | `Here are the tasks in your list: ` <br>`1.[T][ ] Exercise`<br>`2.[E][X] Meet friends (at: May 22nd 5pm)`<br>`3.[D][ ] Watch lecture (by: Sunday 3pm)` |
+
+&nbsp;
+
+### Add ToDo : `todo`
+
+Adds a Todo with description.<br>
+**Format:** `todo <description>`
+
+| | Example |
+| --------- | ------------------------------------------------------- |
+| Input | `todo eat apple` |
+| Output | `Got it. I've added this task:`<br>`[T][ ] eat apple`<br>`Now you have 4 tasks in the list.` |
+
+&nbsp;
+
+### Add Event : `event`
+
+Adds an event with description and datetime.<br>
+**Format:** `event <description> /at <datetime>`
+
+| | Example |
+| --------- | ------------------------------------------------------- |
+| Input | `Celebrate May's birthday /at 05/06/2021 1900` |
+| Output | `Got it. I've added this task:`<br>`[E][ ] party (at: 05/06/2021 1900)`<br>`Now you have 5 tasks in the list.` |`
+
+&nbsp;
+
+### Add Deadline : `deadline`
+
+Adds a deadline with description and datetime.<br>
+**Format:** `deadline <description> /by <datetime>`
+
+| | Example |
+| --------- | ------------------------------------------------------- |
+| Input | `deadline Finish iP /by Sunday 3pm` |
+| Output | `Got it. I've added this task:`<br>`[D][ ] Finish iP (by: Sunday 3pm)`<br>`Now you have 6 tasks in the list.` |
+
+&nbsp;
+
+### Delete Task : `delete`
+
+Deletes a task using specified index.<br>
+**Format:** `delete <index> `
+
+| | Example |
+| --------- | ------------------------------------------------------- |
+| Input | `delete 6` |
+| Output | `Noted, I've removed this task:`<br>`[D][ ] Finish iP (by:  Sunday 3pm)` |
+
+&nbsp;
+
+### Mark Task As Done : `done`
+
+Marks task as done.<br>
+**Format:** `done <index>`
+
+| | Example |
+| --------- | ------------------------------------------------------- |
+| Input | `done 5` |
+| Output | `Great job! I've marked this task as done:`<br>`[X] party` |
+
+&nbsp;
+
+### Find by Keyword : `find`
+
+Displays all tasks containing the keyword.<br>
+**Format:** `find <keyword>`
+
+| | Example |
+| --------- | ------------------------------------------------------- |
+| Input | `find project` |
+| Output | `Here are the matching tasks in your list:`<br>`1. [T][ ] do project` |
+
+&nbsp;
+
+### Exit : `bye`
+
+Exits Application.<br>
+**Format:** `bye`
+
+&nbsp;
+
+## Command summary
+
+| Command | Format |
+| --------- | ------------------------------------------------------- |
+| list | `list` |
+| todo | `todo <description>` |
+| event | `event <description> /at <datetime>` |
+| deadline | `deadline <description> /by <datetime>` |
+| delete | `delete <index>` |
+| done | `done <index>` |
+| find | `find <keyword>` |
+| bye | `bye` |

docs/_config.yml

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

src/main/java/Classes/Deadline.java

@@ -0,0 +1,26 @@
+package Classes;
+
+public class Deadline extends Task {
+    protected String by;
+
+    public Deadline(String description, boolean isDone, String by) {
+        super(description, isDone);
+        this.by = by;
+    }
+
+    /**
+     * @return String containing description of Deadline task
+     */
+    @Override
+    public String toString() {
+        return "[D]" + super.toString() + "(by: " + this.by + ")";
+    }
+
+    /**
+     * @return String of formatted data to be written into the text file
+     */
+    public String formatString() {
+        int done = (isDone ? 1 : 0);
+        return "D-" + done + "-" + description + "-" + by + "\n";
+    }
+}

src/main/java/Classes/Event.java

@@ -0,0 +1,27 @@
+package Classes;
+
+public class Event extends Task {
+    protected String at;
+
+    public Event(String description, boolean isDone, String at) {
+        super(description, isDone);
+        this.at= at;
+    }
+
+    /**
+     * @return String String containing description of Event task
+     */
+    @Override
+    public String toString() {
+        return "[E]" + super.toString() + "(at: " + this.at + ")";
+    }
+
+    /**
+     * @return String of formatted data to be written into the text file
+     */
+    public String formatString() {
+        int done = (isDone ? 1 : 0);
+        return "E-" + done + "-" + description + "-" + at + "\n";
+    }
+}
+

src/main/java/Classes/Task.java

@@ -0,0 +1,49 @@
+package Classes;
+
+public abstract class Task {
+    protected String description;
+    protected boolean isDone;
+
+    public Task(String description) {
+        this.description = description;
+        this.isDone = false;
+    }
+
+    public Task(String description, boolean isDone) {
+        this.description = description;
+        this.isDone = isDone;
+    }
+
+    /**
+     * @return String with a cross sign if a Task is done, else no cross
+     */
+    public String getStatusIcon() {
+        return (isDone ? "X" : " ");
+    }
+
+    /**
+     * @return String with description of Task
+     */
+    public String getDescription() {
+        return this.description;
+    }
+
+    /**
+     * Marks a Task as done
+     */
+    public void markAsDone() {
+        this.isDone = true;
+    }
+
+    /**
+     * @return String contains whether the Task is done and its description
+     */
+    public String toString() {
+        return "[" + getStatusIcon() + "] " + getDescription();
+    }
+
+    /**
+     * @return String of formatted data to be written into the text file
+     */
+    public abstract String formatString();
+}

src/main/java/Classes/Todo.java

@@ -0,0 +1,24 @@
+package Classes;
+
+public class Todo extends Task {
+
+    public Todo(String description, boolean isDone) {
+        super(description, isDone);
+    }
+
+    /**
+     * @return String containing description of Todo task
+     */
+    @Override
+    public String toString() {
+        return "[T]" + super.toString();
+    }
+
+    /**
+     * @return String of formatted data to be written into the text file
+     */
+    public String formatString() {
+        int done = (isDone ? 1 : 0);
+        return "T-" + done + "-" + description + "\n";
+    }
+}